Update function docs for _parsers._is_allowed() function.

testing/mmn/mktime_takes_localtime_not_gmtime
Isis Lovecruft 2013-06-28 01:44:04 +00:00
parent 1e03011296
commit 9b9e441dd7
No known key found for this signature in database
GPG Key ID: A3ADB67A2CDB8B35
1 changed files with 10 additions and 9 deletions

View File

@ -142,16 +142,17 @@ def _hyphenate(input, add_prefix=False):
return ret
def _is_allowed(input):
"""
Check that an option or argument given to GPG is in the set of allowed
"""Check that an option or argument given to GPG is in the set of allowed
options, the latter being a strict subset of the set of all options known
to GPG.
:param str input: An input meant to be parsed as an option or flag to the
GnuPG process. Should be formatted the same as an option
or flag to the commandline gpg, i.e. "--encrypt-files".
:ivar frozenset _possible: All known GPG options and flags.
:ivar frozenset _allowed: All allowed GPG options and flags, e.g. all GPG
:ivar frozenset gnupg_options: All known GPG options and flags.
:ivar frozenset allowed: All allowed GPG options and flags, e.g. all GPG
options and flags which we are willing to
acknowledge and parse. If we want to support a
new option, it will need to have its own parsing