From 8af74f0981afe29fdc915987714a28e6045cb392 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Tue, 21 May 2013 12:59:57 +0000 Subject: [PATCH] Update docstring for GPG._sign_file(). --- src/gnupg.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/gnupg.py b/src/gnupg.py index 729901d..b3b431c 100644 --- a/src/gnupg.py +++ b/src/gnupg.py @@ -743,7 +743,15 @@ use_agent: %s def _sign_file(self, file, keyid=None, passphrase=None, clearsign=True, detach=False, binary=False): - """Create a signature for a file.""" + """Create a signature for a file. + + :param file: The file stream (i.e. it's already been open()'d) to sign. + :param str keyid: The key to sign with. + :param str passphrase: The passphrase to pipe to stdin. + :param bool clearsign: If True, create a cleartext signature. + :param bool detach: If True, create a detached signature. + :param bool binary: If True, do not ascii armour the output. + """ log.debug("_sign_file():") if binary: log.info("Creating binary signature for file %s" % file)