document main (#7610)

I deleted the exceptions because I think it's not feasible to document the possible exceptions raised by all of Certbot.
This commit is contained in:
Brad Warren
2019-12-03 09:51:43 -08:00
committed by GitHub
parent 2008e3cc77
commit e32033f1ec
2 changed files with 10 additions and 8 deletions
+5 -4
View File
@@ -1304,12 +1304,13 @@ def set_displayer(config):
def main(cli_args=None):
"""Command line argument parsing and main script execution.
"""Run Certbot.
:returns: result of requested command
:param cli_args: command line to Certbot, defaults to ``sys.argv[1:]``
:type cli_args: `list` of `str`
:raises errors.Error: OS errors triggered by wrong permissions
:raises errors.Error: error if plugin command is not supported
:returns: value for `sys.exit` about the exit status of Certbot
:rtype: `str` or `int` or `None`
"""
if not cli_args:
+5 -4
View File
@@ -3,12 +3,13 @@ from certbot._internal import main as internal_main
def main(cli_args=None):
"""Command line argument parsing and main script execution.
"""Run Certbot.
:returns: result of requested command
:param cli_args: command line to Certbot, defaults to ``sys.argv[1:]``
:type cli_args: `list` of `str`
:raises errors.Error: OS errors triggered by wrong permissions
:raises errors.Error: error if plugin command is not supported
:returns: value for `sys.exit` about the exit status of Certbot
:rtype: `str` or `int` or `None`
"""
return internal_main.main(cli_args)