python: clarify documentation for verify argument for Context.decrypt()
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Wed, 28 Nov 2018 06:47:20 +0000 (01:47 -0500)
committerAndre Heinecke <aheinecke@intevation.de>
Wed, 5 Dec 2018 10:46:09 +0000 (11:46 +0100)
It's easy to miss that verify can take a list of keys.  Make it more
obvious to the average python dev who reads docstrings.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
lang/python/src/core.py

index f7e843f..0b7b7e0 100644 (file)
@@ -352,7 +352,8 @@ class Context(GpgmeWrapper):
         Keyword arguments:
         sink           -- write result to sink instead of returning it
         passphrase     -- for symmetric decryption
-        verify         -- check signatures (default True)
+        verify         -- check signatures (boolean or iterable of keys,
+                           see above) (default True)
 
         Returns:
         plaintext      -- the decrypted data (or None if sink is given)