python: Improve docstring.

* lang/python/pyme/core.py (Context.set_progress_cb): Improve
docstring.

Signed-off-by: Justus Winter <justus@gnupg.org>
This commit is contained in:
Justus Winter 2016-05-24 15:12:40 +02:00
parent 00e93b2cae
commit 72afb68f8c

View File

@ -173,12 +173,17 @@ class Context(GpgmeWrapper):
pygpgme.pygpgme_set_passphrase_cb(self.wrapped, hookdata, self.last_passcb) pygpgme.pygpgme_set_passphrase_cb(self.wrapped, hookdata, self.last_passcb)
def set_progress_cb(self, func, hook=None): def set_progress_cb(self, func, hook=None):
"""Sets the progress meter callback to the function specified by """Sets the progress meter callback to the function specified by FUNC.
If FUNC is None, the callback will be cleared.
This function will be called to provide an interactive update of This function will be called to provide an interactive update
the system's progress. of the system's progress. The function will be called with
three arguments, type, total, and current. If HOOK is not
None, it will be supplied as fourth argument.
Please see the GPGME manual for more information.""" Please see the GPGME manual for more information.
"""
self._free_progresscb() self._free_progresscb()
if func == None: if func == None:
hookdata = None hookdata = None