python: Improve docstring.
authorJustus Winter <justus@gnupg.org>
Tue, 24 May 2016 13:12:40 +0000 (15:12 +0200)
committerJustus Winter <justus@gnupg.org>
Tue, 24 May 2016 16:00:16 +0000 (18:00 +0200)
* lang/python/pyme/core.py (Context.set_progress_cb): Improve
docstring.

Signed-off-by: Justus Winter <justus@gnupg.org>
lang/python/pyme/core.py

index 1b4e6ae..43a2413 100644 (file)
@@ -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