From e32033f1ec6fa910007d2454f6210e27fe7f98d7 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Tue, 3 Dec 2019 09:51:43 -0800 Subject: [PATCH] document main (#7610) I deleted the exceptions because I think it's not feasible to document the possible exceptions raised by all of Certbot. --- certbot/certbot/_internal/main.py | 9 +++++---- certbot/certbot/main.py | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/certbot/certbot/_internal/main.py b/certbot/certbot/_internal/main.py index c674efd79..3fc858711 100644 --- a/certbot/certbot/_internal/main.py +++ b/certbot/certbot/_internal/main.py @@ -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: diff --git a/certbot/certbot/main.py b/certbot/certbot/main.py index b329f15c5..b2fb1dbb7 100644 --- a/certbot/certbot/main.py +++ b/certbot/certbot/main.py @@ -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)