python: Clarify the meaning of ctx.decrypt(verify=[])
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Tue, 4 Dec 2018 17:27:15 +0000 (20:27 +0300)
committerAndre Heinecke <aheinecke@intevation.de>
Wed, 5 Dec 2018 10:46:09 +0000 (11:46 +0100)
* lang/python/src/core.py (Context.decrypt): docstring clarification
of what it means to pass an empty list to the verify argument.

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

index 87cfd6b..3bd6f71 100644 (file)
@@ -342,7 +342,10 @@ class Context(GpgmeWrapper):
 
         Decrypt the given ciphertext and verify any signatures.  If
         VERIFY is an iterable of keys, the ciphertext must be signed
-        by all those keys, otherwise an error is raised.
+        by all those keys, otherwise an error is raised.  Note: if
+        VERIFY is an empty iterable, that is treated the same as
+        passing verify=True (that is, do verify signatures, but no
+        specific keys are required).
 
         If the ciphertext is symmetrically encrypted using a
         passphrase, that passphrase can be given as parameter, using a