[Pkg-gnupg-commit] [gpgme] 132/412: python: Improve docstring.

[Daniel Kahn Gillmor]

This is an automated email from the git hooks/post-receive script.

dkg pushed a commit to branch master
in repository gpgme.

commit 72afb68f8c2f0cb326f20b289215402fd849339d
Author: Justus Winter <justus at gnupg.org>
Date:   Tue May 24 15:12:40 2016 +0200

    python: Improve docstring.
    
    * lang/python/pyme/core.py (Context.set_progress_cb): Improve
    docstring.
    
    Signed-off-by: Justus Winter <justus at gnupg.org>
---
 lang/python/pyme/core.py | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/lang/python/pyme/core.py b/lang/python/pyme/core.py
index 1b4e6ae..43a2413 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

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-gnupg/gpgme.git