diff options
author | Justus Winter <[email protected]> | 2016-05-24 13:12:40 +0000 |
---|---|---|
committer | Justus Winter <[email protected]> | 2016-05-24 16:00:16 +0000 |
commit | 72afb68f8c2f0cb326f20b289215402fd849339d (patch) | |
tree | 5651c0f8f5bb7582ec07e7f6244b27051f173ece /lang/python/pyme/core.py | |
parent | Qt: Fix test build with clang (diff) | |
download | gpgme-72afb68f8c2f0cb326f20b289215402fd849339d.tar.gz gpgme-72afb68f8c2f0cb326f20b289215402fd849339d.zip |
python: Improve docstring.
* lang/python/pyme/core.py (Context.set_progress_cb): Improve
docstring.
Signed-off-by: Justus Winter <[email protected]>
Diffstat (limited to 'lang/python/pyme/core.py')
-rw-r--r-- | lang/python/pyme/core.py | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/lang/python/pyme/core.py b/lang/python/pyme/core.py index 1b4e6ae0..43a24131 100644 --- a/lang/python/pyme/core.py +++ b/lang/python/pyme/core.py @@ -173,12 +173,17 @@ class Context(GpgmeWrapper): pygpgme.pygpgme_set_passphrase_cb(self.wrapped, hookdata, self.last_passcb) 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 - the system's progress. + This function will be called to provide an interactive update + 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() if func == None: hookdata = None |