Update docstring for GPG._sign_file().

testing/mmn/mktime_takes_localtime_not_gmtime
Isis Lovecruft 2013-05-21 12:59:57 +00:00
parent d9b7a85fe6
commit 8af74f0981
No known key found for this signature in database
GPG Key ID: A3ADB67A2CDB8B35
1 changed files with 9 additions and 1 deletions

View File

@ -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)