From a9faa376e7b2c1dffeeef36da6222b3f64f7d57d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 17 Apr 2013 20:54:39 +0000 Subject: [PATCH] Update docstring for GPG.genkey(). --- gnupg/gnupg.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/gnupg/gnupg.py b/gnupg/gnupg.py index 7c9b630..65c8ee2 100644 --- a/gnupg/gnupg.py +++ b/gnupg/gnupg.py @@ -678,9 +678,8 @@ class GPG(object): raise NotImplemented("Functionality for '--list-sigs' not implemented.") def gen_key(self, input): - """ - Generate a key; you might use gen_key_input() to create the control - input. + """Generate a GnuPG key through batch file key generation. See + :meth:`GPG.gen_key_input()` for creating the control input. >>> gpg = GPG(gpghome="keys") >>> input = gpg.gen_key_input() @@ -689,6 +688,10 @@ class GPG(object): >>> result = gpg.gen_key('foo') >>> assert not result + :param dict input: A dictionary of parameters and values for the new + key. + :returns: The result mapping with details of the new key, which is a + :class:`parsers.GenKey ` object. """ args = ["--gen-key --batch"] key = self._result_map['generate'](self)