starred/certbot-certbot-2
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-01 16:19:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Correct docstrings & associated typing confusion

Browse Source
This commit is contained in:
Peter Eckersley
2015-12-30 15:52:51 -08:00
parent ef09362a9f
commit d358c8d1c0
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
letsencrypt/display/util.py
+12 -10
View File
@@ -77,9 +77,9 @@ class NcursesDisplay(object):
:param str help_label: label of the help button
:param dict _kwargs: absorbs default / cli_args
:returns: tuple of the form (`code`, `tag`) where
`code` - `str` display_util exit code
`tag` - `int` index corresponding to the item chosen
:returns: tuple of the form (code, tag) where
code - int display exit code
tag - str corresponding to the item chosen
:rtype: tuple
"""
@@ -217,9 +217,10 @@ class FileDisplay(object):
list of descriptions (tags will be enumerated)
:param dict _kwargs: absorbs default / cli_args
:returns: tuple of the form (code, tag) where
code - int display exit code
tag - str corresponding to the item chosen
:returns: tuple of (`code`, `index`) where
`code` - str display exit code
`index` - int index of the user's selection
:rtype: tuple
"""
@@ -452,11 +453,12 @@ class NoninteractiveDisplay(object):
:param choices: Menu lines, len must be > 0
:type choices: list of tuples (tag, item) or
list of descriptions (tags will be enumerated)
:param int default: the default choice
:param dict kwargs: absorbs various irrelevant labelling arguments
:returns: tuple of the form (code, tag) where
code - int display exit code
tag - str corresponding to the item chosen
:returns: tuple of (`code`, `index`) where
`code` - str display exit code
`index` - int index of the user's selection
:rtype: tuple
:raises errors.MissingCommandlineFlag: if there was no default
@@ -464,7 +466,7 @@ class NoninteractiveDisplay(object):
if default is None:
self._interaction_fail(message, cli_flag, "Choices: " + repr(choices))
return OK, choices.index(default)
return OK, default
def input(self, message, default=None, cli_flag=None):
"""Accept input from the user.