Qubes/core-admin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

api: add missing docstring

Browse Source
This commit is contained in:
Marek Marczykowski-Górecki 2017-06-27 02:00:47 +02:00
parent 3d803acfde
commit 291a338e73
No known key found for this signature in database
GPG Key ID: 063938BA42CFA724
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
qubes/api/__init__.py
View File

@ -51,6 +51,8 @@ def method(name, *, no_payload=False, endpoints=None, **classifiers):
:param str name: qrexec rpc method name :param str name: qrexec rpc method name
:param bool no_payload: if :py:obj:`True`, will barf on non-empty payload; \ :param bool no_payload: if :py:obj:`True`, will barf on non-empty payload; \
also will not pass payload at all to the method also will not pass payload at all to the method
:param iterable endpoints: if specified, method serve multiple API calls
generated by replacing `{endpoint}` with each value in this iterable
The expected function method should have one argument (other than usual The expected function method should have one argument (other than usual
*self*), ``untrusted_payload``, which will contain the payload. *self*), ``untrusted_payload``, which will contain the payload.