From 0137055c240f4bd4fd6475d7df93eb2ac2288b04 Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Sun, 5 Nov 2017 21:59:55 +0100
Subject: [PATCH 01/10] First shot at updates at documentation, plenty of
 questions left at issue #4736

---
 certbot/main.py | 262 +++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 237 insertions(+), 25 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 9e2850891..77d474d5f 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -43,7 +43,14 @@ logger = logging.getLogger(__name__)
 
 
 def _suggest_donation_if_appropriate(config):
-    """Potentially suggest a donation to support Certbot."""
+    """Potentially suggest a donation to support Certbot.
+
+    :param interfaces.IConfig config: Configuration object
+
+    :returns: `None`
+    :rtype: None
+
+    """
     assert config.verb != "renew"
     if config.staging:
         # --dry-run implies --staging
@@ -55,6 +62,14 @@ def _suggest_donation_if_appropriate(config):
     reporter_util.add_message(msg, reporter_util.LOW_PRIORITY)
 
 def _report_successful_dry_run(config):
+    """Reports on successful dry run
+
+    :param interfaces.IConfig config: Configuration object
+
+    :returns: `None`
+    :rtype: None
+
+    """
     reporter_util = zope.component.getUtility(interfaces.IReporter)
     assert config.verb != "renew"
     reporter_util.add_message("The dry run was successful.",
@@ -68,8 +83,16 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
     then performs that action. Includes calls to hooks, various reports,
     checks, and requests for user input.
 
+    :param interfaces.IConfig config: Configuration object
+    :param list domains: domains to get a certificate. This argument is optional, if not supplied it will default to `None`
+    :param str certname: Name of new cert. This argument is optional, if not supplied it will default to `None`
+    :param storage.RenewableCert lineage:
+
     :returns: the issued certificate or `None` if doing a dry run
-    :rtype: `storage.RenewableCert` or `None`
+    :rtype: storage.RenewableCert or None
+
+    :raises errors.Error: if certificate could not be obtained
+
     """
     hooks.pre_hook(config)
     try:
@@ -96,6 +119,8 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
 def _handle_subset_cert_request(config, domains, cert):
     """Figure out what to do if a previous cert had a subset of the names now requested
 
+    :param interfaces.IConfig config: Configuration object
+    :param list domains: Domain names.
     :param storage.RenewableCert cert:
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
@@ -137,6 +162,7 @@ def _handle_subset_cert_request(config, domains, cert):
 def _handle_identical_cert_request(config, lineage):
     """Figure out what to do if a lineage has the same names as a previously obtained one
 
+    :param interfaces.IConfig config: Configuration object
     :param storage.RenewableCert lineage:
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
@@ -186,11 +212,14 @@ def _find_lineage_for_domains(config, domains):
     the client run if the user chooses to cancel the operation when
     prompted).
 
+    :param interfaces.IConfig config: Configuration object
+    :param list domains: Domain names.
+
     :returns: Two-element tuple containing desired new-certificate behavior as
               a string token ("reinstall", "renew", or "newcert"), plus either
-              a RenewableCert instance or None if renewal shouldn't occur.
+              a RenewableCert instance or `None` if renewal shouldn't occur.
 
-    :raises .Error: If the user would like to rerun the client again.
+    :raises errors.Error: If the user would like to rerun the client again.
 
     """
     # Considering the possibility that the requested certificate is
@@ -214,6 +243,10 @@ def _find_lineage_for_domains(config, domains):
 def _find_cert(config, domains, certname):
     """Finds an existing certificate object given domains and/or a certificate name.
 
+    :param interfaces.IConfig config: Configuration object
+    :param list domains: Domain names.
+    :param str certname: Name of cert
+
     :returns: Two-element tuple of a boolean that indicates if this function should be
               followed by a call to fetch a certificate from the server, and either a
               RenewableCert instance or None.
@@ -226,11 +259,15 @@ def _find_cert(config, domains, certname):
 def _find_lineage_for_domains_and_certname(config, domains, certname):
     """Find appropriate lineage based on given domains and/or certname.
 
+    :param interfaces.IConfig config: Configuration object
+    :param list domains: Domain names.
+    :param str certname: Name of cert
+
     :returns: Two-element tuple containing desired new-certificate behavior as
               a string token ("reinstall", "renew", or "newcert"), plus either
-              a RenewableCert instance or None if renewal shouldn't occur.
+              a RenewableCert instance or None if renewal should not occur.
 
-    :raises .Error: If the user would like to rerun the client again.
+    :raises errors.Error: If the user would like to rerun the client again.
 
     """
     if not certname:
@@ -255,6 +292,17 @@ def _find_lineage_for_domains_and_certname(config, domains, certname):
 
 def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains):
     """Ask user to confirm update cert certname to contain new_domains.
+
+    :param interfaces.IConfig config: Configuration object
+    :param list new_domains: Domain names.
+    :param str certname: Name of cert
+    :param list old_domains: Domain names.
+
+    :returns: None
+    :rtype: None
+
+    :raises errors.ConfigurationError: if cert name and domains mismatch
+
     """
     if config.renew_with_new_domains:
         return
@@ -272,6 +320,15 @@ def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains):
 
 def _find_domains_or_certname(config, installer):
     """Retrieve domains and certname from config or user input.
+
+    :param interfaces.IConfig config: Configuration object
+    :param: TODO installer?
+
+    :returns: Two-part tuple of domains and certname
+    :rtype: tuple
+
+    :raises errors.Error: Usage message, if parameters are not used correctly
+
     """
     domains = None
     certname = config.certname
@@ -303,6 +360,9 @@ def _report_new_cert(config, cert_path, fullchain_path, key_path=None):
     :param str fullchain_path: path to full chain
     :param str key_path: path to private key, if available
 
+    :returns: 'None'
+    :rtype: None
+
     """
     if config.dry_run:
         _report_successful_dry_run(config)
@@ -337,14 +397,13 @@ def _determine_account(config):
     if ``config.account`` is ``None``, it will be updated based on the
     user input. Same for ``config.email``.
 
-    :param argparse.Namespace config: CLI arguments
-    :param certbot.interface.IConfig config: Configuration object
-    :param .AccountStorage account_storage: Account storage.
+    :param interfaces.IConfig config: Configuration object
 
     :returns: Account and optionally ACME client API (biproduct of new
         registration).
-    :rtype: `tuple` of `certbot.account.Account` and
-        `acme.client.Client`
+    :rtype: tuple of certbot.account.Account and acme.client.Client
+
+    :raises errors.Error: If unable to register an account with ACME server
 
     """
     account_storage = account.AccountFileStorage(config)
@@ -394,7 +453,7 @@ def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-b
 
     :param `configuration.NamespaceConfig` config: parsed command line arguments
 
-    :raises `error.Errors`: If anything goes wrong, including bad user input, if an overlapping
+    :raises errors.Error: If anything goes wrong, including bad user input, if an overlapping
         archive dir is found for the specified lineage, etc ...
     """
     display = zope.component.getUtility(interfaces.IDisplay)
@@ -474,6 +533,15 @@ def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-b
 
 
 def _init_le_client(config, authenticator, installer):
+    """Initialize Let's Encrypt Client
+
+    :param interfaces.IConfig config: Configuration object
+    :param: TODO authenticator
+    :param: TODO installer
+
+    :returns: client: Client object
+
+    """
     if authenticator is not None:
         # if authenticator was given, then we will need account...
         acc, acme = _determine_account(config)
@@ -487,7 +555,15 @@ def _init_le_client(config, authenticator, installer):
 
 
 def unregister(config, unused_plugins):
-    """Deactivate account on server"""
+    """Deactivate account on server
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
+    """
     account_storage = account.AccountFileStorage(config)
     accounts = account_storage.find_all()
     reporter_util = zope.component.getUtility(interfaces.IReporter)
@@ -516,8 +592,15 @@ def unregister(config, unused_plugins):
 
 
 def register(config, unused_plugins):
-    """Create or modify accounts on the server."""
+    """Create or modify accounts on the server.
 
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None` or a string indicating and error
+    :rtype: None or str
+
+    """
     # Portion of _determine_account logic to see whether accounts already
     # exist or not.
     account_storage = account.AccountFileStorage(config)
@@ -566,7 +649,15 @@ def _install_cert(config, le_client, domains, lineage=None):
     le_client.enhance_config(domains, path_provider.chain_path)
 
 def install(config, plugins):
-    """Install a previously obtained cert in a server."""
+    """Install a previously obtained cert in a server.
+
+    :param interfaces.IConfig config: Configuration object
+    :param plugins: list of plugins
+
+    :returns: `None`
+    :rtype: None
+
+    """
     # XXX: Update for renewer/RenewableCert
     # FIXME: be consistent about whether errors are raised or returned from
     # this function ...
@@ -582,7 +673,15 @@ def install(config, plugins):
 
 
 def plugins_cmd(config, plugins):
-    """List server software plugins."""
+    """List server software plugins.
+
+    :param interfaces.IConfig config: Configuration object
+    :param plugins: list of plugins
+
+    :returns: `None`
+    :rtype: None
+
+    """
     logger.debug("Expected interfaces: %s", config.ifaces)
 
     ifaces = [] if config.ifaces is None else config.ifaces
@@ -610,7 +709,15 @@ def plugins_cmd(config, plugins):
 
 
 def rollback(config, plugins):
-    """Rollback server configuration changes made during install."""
+    """Rollback server configuration changes made during install.
+
+    :param interfaces.IConfig config: Configuration object
+    :param plugins: list of plugins
+
+    :returns: `None`
+    :rtype: None
+
+    """
     client.rollback(config.installer, config.checkpoints, config, plugins)
 
 
@@ -619,6 +726,12 @@ def config_changes(config, unused_plugins):
 
     View checkpoints and associated configuration changes.
 
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
     """
     client.view_config_changes(config, num=config.num)
 
@@ -627,6 +740,13 @@ def update_symlinks(config, unused_plugins):
 
     Use the information in the config file to make symlinks point to
     the correct archive directory.
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
     """
     cert_manager.update_live_symlinks(config)
 
@@ -635,6 +755,13 @@ def rename(config, unused_plugins):
 
     Use the information in the config file to rename an existing
     lineage.
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
     """
     cert_manager.rename_lineage(config)
 
@@ -643,16 +770,37 @@ def delete(config, unused_plugins):
 
     Use the information in the config file to delete an existing
     lineage.
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
     """
     cert_manager.delete(config)
 
 def certificates(config, unused_plugins):
     """Display information about certs configured with Certbot
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
     """
     cert_manager.certificates(config)
 
 def revoke(config, unused_plugins):  # TODO: coop with renewal config
-    """Revoke a previously obtained certificate."""
+    """Revoke a previously obtained certificate.
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None` returns string indicating error in case of error
+    :rtype: None or str
+
+    """
     # For user-agent construction
     config.installer = config.authenticator = "None"
     if config.key_path is not None:  # revocation by cert key
@@ -678,7 +826,15 @@ def revoke(config, unused_plugins):  # TODO: coop with renewal config
 
 
 def run(config, plugins):  # pylint: disable=too-many-branches,too-many-locals
-    """Obtain a certificate and install."""
+    """Obtain a certificate and install.
+
+    :param interfaces.IConfig config: Configuration object
+    :param plugins: list of plugins
+
+    :returns: `None`
+    :rtype: None
+
+    """
     # TODO: Make run as close to auth + install as possible
     # Possible difficulties: config.csr was hacked into auth
     try:
@@ -718,6 +874,13 @@ def _csr_get_and_save_cert(config, le_client):
     This works differently in the CSR case (for now) because we don't
     have the privkey, and therefore can't construct the files for a lineage.
     So we just save the cert & chain to disk :/
+
+    :param interfaces.IConfig config: Configuration object
+    :param client.Client client: Client object
+
+    :returns: `cert_path` and `fullchain_path` as absolute paths to the actual files
+    :rtype: tuple of str
+
     """
     csr, _ = config.actual_csr
     certr, chain = le_client.obtain_certificate_from_csr(config.domains, csr)
@@ -730,7 +893,19 @@ def _csr_get_and_save_cert(config, le_client):
     return cert_path, fullchain_path
 
 def renew_cert(config, plugins, lineage):
-    """Renew & save an existing cert. Do not install it."""
+    """Renew & save an existing cert. Do not install it.
+
+    :param interfaces.IConfig config: Configuration object
+    :param plugins: TODO
+    :param lineage: TODO
+
+    :returns: `None`
+    :rtype: None
+
+    :raises errors.PluginSelectionError: MissingCommandlineFlag in case supplied parameters do not pass
+
+
+    """
     try:
         # installers are used in auth mode to determine domain names
         installer, auth = plug_sel.choose_configurator_plugins(config, plugins, "certonly")
@@ -757,8 +932,17 @@ def renew_cert(config, plugins, lineage):
 def certonly(config, plugins):
     """Authenticate & obtain cert, but do not install it.
 
-    This implements the 'certonly' subcommand."""
+    This implements the 'certonly' subcommand.
 
+    :param interfaces.IConfig config: Configuration object
+    :param: TODO plugins
+
+    :returns: `None`
+    :rtype: None
+
+    :raises errors.Error: If specified plugin could not be used
+
+    """
     # SETUP: Select plugins and construct a client instance
     try:
         # installers are used in auth mode to determine domain names
@@ -792,7 +976,15 @@ def certonly(config, plugins):
     _suggest_donation_if_appropriate(config)
 
 def renew(config, unused_plugins):
-    """Renew previously-obtained certificates."""
+    """Renew previously-obtained certificates.
+
+    :param interfaces.IConfig config: Configuration object
+    :param unused_plugins: list of plugins (deprecated)
+
+    :returns: `None`
+    :rtype: None
+
+    """
     try:
         renewal.handle_renewal_request(config)
     finally:
@@ -800,7 +992,14 @@ def renew(config, unused_plugins):
 
 
 def make_or_verify_needed_dirs(config):
-    """Create or verify existence of config, work, and hook directories."""
+    """Create or verify existence of config, work, and hook directories.
+
+    :param interfaces.IConfig config: Configuration object
+
+    :returns: `None`
+    :rtype: None
+
+    """
     util.set_up_core_dir(config.config_dir, constants.CONFIG_DIRS_MODE,
                          os.geteuid(), config.strict_permissions)
     util.set_up_core_dir(config.work_dir, constants.CONFIG_DIRS_MODE,
@@ -816,7 +1015,14 @@ def make_or_verify_needed_dirs(config):
 
 
 def set_displayer(config):
-    """Set the displayer"""
+    """Set the displayer
+
+    :param interfaces.IConfig config: Configuration object
+
+    :returns: `None`
+    :rtype: None
+
+    """
     if config.quiet:
         config.noninteractive_mode = True
         displayer = display_util.NoninteractiveDisplay(open(os.devnull, "w"))
@@ -829,7 +1035,13 @@ def set_displayer(config):
 
 
 def main(cli_args=sys.argv[1:]):
-    """Command line argument parsing and main script execution."""
+    """Command line argument parsing and main script execution.
+
+    :returns: TODO
+
+    :raises errors.Error: General operating system errors triggered by issues related to wrong permissions
+
+    """
     log.pre_arg_parse_setup()
 
     plugins = plugins_disco.PluginsRegistry.find_all()

From 4e73d7ce00ce76fa0ef5b5c653f7943e436b6a7a Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Tue, 7 Nov 2017 21:24:30 +0100
Subject: [PATCH 02/10] Specified the list parameters after reading up on lists
 as parameters Ref:
 https://stackoverflow.com/questions/3961007/passing-an-array-list-into-python

---
 certbot/main.py | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 77d474d5f..273cc0263 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -558,7 +558,7 @@ def unregister(config, unused_plugins):
     """Deactivate account on server
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -595,7 +595,7 @@ def register(config, unused_plugins):
     """Create or modify accounts on the server.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None` or a string indicating and error
     :rtype: None or str
@@ -652,7 +652,7 @@ def install(config, plugins):
     """Install a previously obtained cert in a server.
 
     :param interfaces.IConfig config: Configuration object
-    :param plugins: list of plugins
+    :param list plugins: list of plugins
 
     :returns: `None`
     :rtype: None
@@ -676,7 +676,7 @@ def plugins_cmd(config, plugins):
     """List server software plugins.
 
     :param interfaces.IConfig config: Configuration object
-    :param plugins: list of plugins
+    :param list plugins: list of plugins
 
     :returns: `None`
     :rtype: None
@@ -712,7 +712,7 @@ def rollback(config, plugins):
     """Rollback server configuration changes made during install.
 
     :param interfaces.IConfig config: Configuration object
-    :param plugins: list of plugins
+    :param list plugins: list of plugins
 
     :returns: `None`
     :rtype: None
@@ -727,7 +727,7 @@ def config_changes(config, unused_plugins):
     View checkpoints and associated configuration changes.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -742,7 +742,7 @@ def update_symlinks(config, unused_plugins):
     the correct archive directory.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -757,7 +757,7 @@ def rename(config, unused_plugins):
     lineage.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -772,7 +772,7 @@ def delete(config, unused_plugins):
     lineage.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -784,7 +784,7 @@ def certificates(config, unused_plugins):
     """Display information about certs configured with Certbot
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None
@@ -795,7 +795,7 @@ def revoke(config, unused_plugins):  # TODO: coop with renewal config
     """Revoke a previously obtained certificate.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None` returns string indicating error in case of error
     :rtype: None or str
@@ -829,7 +829,7 @@ def run(config, plugins):  # pylint: disable=too-many-branches,too-many-locals
     """Obtain a certificate and install.
 
     :param interfaces.IConfig config: Configuration object
-    :param plugins: list of plugins
+    :param list plugins: list of plugins
 
     :returns: `None`
     :rtype: None
@@ -896,7 +896,7 @@ def renew_cert(config, plugins, lineage):
     """Renew & save an existing cert. Do not install it.
 
     :param interfaces.IConfig config: Configuration object
-    :param plugins: TODO
+    :param list plugins: TODO
     :param lineage: TODO
 
     :returns: `None`
@@ -935,7 +935,7 @@ def certonly(config, plugins):
     This implements the 'certonly' subcommand.
 
     :param interfaces.IConfig config: Configuration object
-    :param: TODO plugins
+    :param list plugins: List of plugins
 
     :returns: `None`
     :rtype: None
@@ -979,7 +979,7 @@ def renew(config, unused_plugins):
     """Renew previously-obtained certificates.
 
     :param interfaces.IConfig config: Configuration object
-    :param unused_plugins: list of plugins (deprecated)
+    :param list unused_plugins: list of plugins (deprecated)
 
     :returns: `None`
     :rtype: None

From 89485f7463123f2a687876e5950a6f729c66e37f Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Tue, 7 Nov 2017 21:40:35 +0100
Subject: [PATCH 03/10] I think I figured out the authentication handler object

---
 certbot/main.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 273cc0263..6c9e377ef 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -322,7 +322,7 @@ def _find_domains_or_certname(config, installer):
     """Retrieve domains and certname from config or user input.
 
     :param interfaces.IConfig config: Configuration object
-    :param: TODO installer?
+    :param installer: Installer object
 
     :returns: Two-part tuple of domains and certname
     :rtype: tuple
@@ -536,8 +536,8 @@ def _init_le_client(config, authenticator, installer):
     """Initialize Let's Encrypt Client
 
     :param interfaces.IConfig config: Configuration object
-    :param: TODO authenticator
-    :param: TODO installer
+    :param AuthHandler authenticator: Acme authentication handler
+    :param installer: Installer object
 
     :returns: client: Client object
 
@@ -896,7 +896,7 @@ def renew_cert(config, plugins, lineage):
     """Renew & save an existing cert. Do not install it.
 
     :param interfaces.IConfig config: Configuration object
-    :param list plugins: TODO
+    :param list plugins: List of plugins
     :param lineage: TODO
 
     :returns: `None`

From 0aa9322280f9ad7a780c470607c4da1c1ca1bb1d Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Tue, 7 Nov 2017 21:47:59 +0100
Subject: [PATCH 04/10] Added a shot at what might be the proper type, I need
 to get a better understanding of certbot's datatypes

---
 certbot/main.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/certbot/main.py b/certbot/main.py
index 6c9e377ef..f3096da6c 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -897,7 +897,7 @@ def renew_cert(config, plugins, lineage):
 
     :param interfaces.IConfig config: Configuration object
     :param list plugins: List of plugins
-    :param lineage: TODO
+    :param RenewableCert lineage: a certificate lineage object
 
     :returns: `None`
     :rtype: None

From 1173acfaf0a377917442d7becd16dd863a1f27aa Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Tue, 7 Nov 2017 22:18:11 +0100
Subject: [PATCH 05/10] Making friends with the linter

lint: commands succeeded
congratulations :)
---
 certbot/main.py | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index f3096da6c..5f2803da7 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -84,8 +84,11 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
     checks, and requests for user input.
 
     :param interfaces.IConfig config: Configuration object
-    :param list domains: domains to get a certificate. This argument is optional, if not supplied it will default to `None`
-    :param str certname: Name of new cert. This argument is optional, if not supplied it will default to `None`
+
+    :param list domains: domains to get a certificate. Defaults to `None`
+
+    :param str certname: Name of new cert. Defaults to `None`
+
     :param storage.RenewableCert lineage:
 
     :returns: the issued certificate or `None` if doing a dry run
@@ -902,8 +905,7 @@ def renew_cert(config, plugins, lineage):
     :returns: `None`
     :rtype: None
 
-    :raises errors.PluginSelectionError: MissingCommandlineFlag in case supplied parameters do not pass
-
+    :raises errors.PluginSelectionError: MissingCommandlineFlag if supplied parameters do not pass
 
     """
     try:
@@ -1039,7 +1041,7 @@ def main(cli_args=sys.argv[1:]):
 
     :returns: TODO
 
-    :raises errors.Error: General operating system errors triggered by issues related to wrong permissions
+    :raises errors.Error: OS errors triggered by wrong permissions
 
     """
     log.pre_arg_parse_setup()

From eb26e0aacf4ac2454fe8eb5dcb8a529b466737e1 Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Sun, 12 Nov 2017 00:32:24 +0100
Subject: [PATCH 06/10] Updated parameter types for a lot of parametersm some
 aspects are still a bug unclear, hopefully a review can shed some light on
 this details

---
 certbot/main.py | 235 ++++++++++++++++++++++++++++++++++--------------
 1 file changed, 167 insertions(+), 68 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 5f2803da7..089149858 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -45,7 +45,8 @@ logger = logging.getLogger(__name__)
 def _suggest_donation_if_appropriate(config):
     """Potentially suggest a donation to support Certbot.
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
     :returns: `None`
     :rtype: None
@@ -64,7 +65,8 @@ def _suggest_donation_if_appropriate(config):
 def _report_successful_dry_run(config):
     """Reports on successful dry run
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
     :returns: `None`
     :rtype: None
@@ -83,13 +85,17 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
     then performs that action. Includes calls to hooks, various reports,
     checks, and requests for user input.
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
-    :param list domains: domains to get a certificate. Defaults to `None`
+    :param domains: domains to get a certificate. Defaults to `None`
+    :type domains: `list` of `str`
 
-    :param str certname: Name of new cert. Defaults to `None`
+    :param certname: Name of new cert. Defaults to `None`
+    :type certname: str
 
-    :param storage.RenewableCert lineage:
+    :param lineage:
+    :type lineage: storage.RenewableCert
 
     :returns: the issued certificate or `None` if doing a dry run
     :rtype: storage.RenewableCert or None
@@ -122,9 +128,14 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
 def _handle_subset_cert_request(config, domains, cert):
     """Figure out what to do if a previous cert had a subset of the names now requested
 
-    :param interfaces.IConfig config: Configuration object
-    :param list domains: Domain names.
-    :param storage.RenewableCert cert:
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param domains: domains
+    :type domains: `list` of `str`
+
+    :param cert:
+    :type cert: storage.RenewableCert
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
               action can be: "newcert" | "renew" | "reinstall"
@@ -165,8 +176,11 @@ def _handle_subset_cert_request(config, domains, cert):
 def _handle_identical_cert_request(config, lineage):
     """Figure out what to do if a lineage has the same names as a previously obtained one
 
-    :param interfaces.IConfig config: Configuration object
-    :param storage.RenewableCert lineage:
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param lineage:
+    :type lineage: storage.RenewableCert
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
               action can be: "newcert" | "renew" | "reinstall"
@@ -215,8 +229,11 @@ def _find_lineage_for_domains(config, domains):
     the client run if the user chooses to cancel the operation when
     prompted).
 
-    :param interfaces.IConfig config: Configuration object
-    :param list domains: Domain names.
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param domains: domains
+    :type domains: `list` of `str`
 
     :returns: Two-element tuple containing desired new-certificate behavior as
               a string token ("reinstall", "renew", or "newcert"), plus either
@@ -246,9 +263,14 @@ def _find_lineage_for_domains(config, domains):
 def _find_cert(config, domains, certname):
     """Finds an existing certificate object given domains and/or a certificate name.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list domains: Domain names.
-    :param str certname: Name of cert
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param domains: domains
+    :type domains: `list` of `str`
+
+    :param certname: Name of cert
+    :type certname: str
 
     :returns: Two-element tuple of a boolean that indicates if this function should be
               followed by a call to fetch a certificate from the server, and either a
@@ -262,9 +284,14 @@ def _find_cert(config, domains, certname):
 def _find_lineage_for_domains_and_certname(config, domains, certname):
     """Find appropriate lineage based on given domains and/or certname.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list domains: Domain names.
-    :param str certname: Name of cert
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param domains: domains
+    :type domains: `list` of `str`
+
+    :param certname: Name of cert
+    :type certname: str
 
     :returns: Two-element tuple containing desired new-certificate behavior as
               a string token ("reinstall", "renew", or "newcert"), plus either
@@ -296,10 +323,17 @@ def _find_lineage_for_domains_and_certname(config, domains, certname):
 def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains):
     """Ask user to confirm update cert certname to contain new_domains.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list new_domains: Domain names.
-    :param str certname: Name of cert
-    :param list old_domains: Domain names.
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param new_domains: domains
+    :type new_domains: `list` of `str`
+
+    :param certname: Name of cert
+    :type certname: str
+
+    :param old_domains: domains
+    :type old_domains: `list` of `str`
 
     :returns: None
     :rtype: None
@@ -324,8 +358,12 @@ def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains):
 def _find_domains_or_certname(config, installer):
     """Retrieve domains and certname from config or user input.
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
     :param installer: Installer object
+    :type installer: interfaces.IInstaller
+
 
     :returns: Two-part tuple of domains and certname
     :rtype: tuple
@@ -359,11 +397,14 @@ def _find_domains_or_certname(config, installer):
 def _report_new_cert(config, cert_path, fullchain_path, key_path=None):
     """Reports the creation of a new certificate to the user.
 
-    :param str cert_path: path to cert
-    :param str fullchain_path: path to full chain
-    :param str key_path: path to private key, if available
+    :param cert_path: path to cert
+    :type cert_path: str
+    :param fullchain_path: path to full chain
+    :type fullchain_path: str
+    :param key_path: path to private key, if available
+    :type key_path: str
 
-    :returns: 'None'
+    :returns: `None`
     :rtype: None
 
     """
@@ -400,7 +441,8 @@ def _determine_account(config):
     if ``config.account`` is ``None``, it will be updated based on the
     user input. Same for ``config.email``.
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
     :returns: Account and optionally ACME client API (biproduct of new
         registration).
@@ -538,9 +580,13 @@ def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-b
 def _init_le_client(config, authenticator, installer):
     """Initialize Let's Encrypt Client
 
-    :param interfaces.IConfig config: Configuration object
-    :param AuthHandler authenticator: Acme authentication handler
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param authenticator: Acme authentication handler
+    :type authenticator: interfaces.IAuthenticator
     :param installer: Installer object
+    :type installer: interfaces.IInstaller
 
     :returns: client: Client object
 
@@ -560,8 +606,11 @@ def _init_le_client(config, authenticator, installer):
 def unregister(config, unused_plugins):
     """Deactivate account on server
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -597,8 +646,11 @@ def unregister(config, unused_plugins):
 def register(config, unused_plugins):
     """Create or modify accounts on the server.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None` or a string indicating and error
     :rtype: None or str
@@ -654,8 +706,11 @@ def _install_cert(config, le_client, domains, lineage=None):
 def install(config, plugins):
     """Install a previously obtained cert in a server.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: list of plugins
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -678,8 +733,11 @@ def install(config, plugins):
 def plugins_cmd(config, plugins):
     """List server software plugins.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: list of plugins
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -714,8 +772,11 @@ def plugins_cmd(config, plugins):
 def rollback(config, plugins):
     """Rollback server configuration changes made during install.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: list of plugins
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -729,8 +790,11 @@ def config_changes(config, unused_plugins):
 
     View checkpoints and associated configuration changes.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -744,8 +808,11 @@ def update_symlinks(config, unused_plugins):
     Use the information in the config file to make symlinks point to
     the correct archive directory.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -759,8 +826,11 @@ def rename(config, unused_plugins):
     Use the information in the config file to rename an existing
     lineage.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -774,8 +844,11 @@ def delete(config, unused_plugins):
     Use the information in the config file to delete an existing
     lineage.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -786,8 +859,11 @@ def delete(config, unused_plugins):
 def certificates(config, unused_plugins):
     """Display information about certs configured with Certbot
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -797,10 +873,13 @@ def certificates(config, unused_plugins):
 def revoke(config, unused_plugins):  # TODO: coop with renewal config
     """Revoke a previously obtained certificate.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
-    :returns: `None` returns string indicating error in case of error
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
+
+    :returns: `None` or string indicating error in case of error
     :rtype: None or str
 
     """
@@ -831,8 +910,11 @@ def revoke(config, unused_plugins):  # TODO: coop with renewal config
 def run(config, plugins):  # pylint: disable=too-many-branches,too-many-locals
     """Obtain a certificate and install.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: list of plugins
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -878,8 +960,11 @@ def _csr_get_and_save_cert(config, le_client):
     have the privkey, and therefore can't construct the files for a lineage.
     So we just save the cert & chain to disk :/
 
-    :param interfaces.IConfig config: Configuration object
-    :param client.Client client: Client object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param client: Client object
+    :type client: client.Client
 
     :returns: `cert_path` and `fullchain_path` as absolute paths to the actual files
     :rtype: tuple of str
@@ -898,9 +983,14 @@ def _csr_get_and_save_cert(config, le_client):
 def renew_cert(config, plugins, lineage):
     """Renew & save an existing cert. Do not install it.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: List of plugins
-    :param RenewableCert lineage: a certificate lineage object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
+
+    :param lineage: certificate lineage object
+    :type lineage: storage.RenewableCert
 
     :returns: `None`
     :rtype: None
@@ -936,8 +1026,11 @@ def certonly(config, plugins):
 
     This implements the 'certonly' subcommand.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list plugins: List of plugins
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param plugins: list of plugins
+    :type plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -980,8 +1073,11 @@ def certonly(config, plugins):
 def renew(config, unused_plugins):
     """Renew previously-obtained certificates.
 
-    :param interfaces.IConfig config: Configuration object
-    :param list unused_plugins: list of plugins (deprecated)
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param unused_plugins: list of plugins (deprecated)
+    :type unused_plugins: `list` of `str`
 
     :returns: `None`
     :rtype: None
@@ -996,7 +1092,8 @@ def renew(config, unused_plugins):
 def make_or_verify_needed_dirs(config):
     """Create or verify existence of config, work, and hook directories.
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
     :returns: `None`
     :rtype: None
@@ -1019,7 +1116,8 @@ def make_or_verify_needed_dirs(config):
 def set_displayer(config):
     """Set the displayer
 
-    :param interfaces.IConfig config: Configuration object
+    :param config: Configuration object
+    :type config: interfaces.IConfig
 
     :returns: `None`
     :rtype: None
@@ -1039,9 +1137,10 @@ def set_displayer(config):
 def main(cli_args=sys.argv[1:]):
     """Command line argument parsing and main script execution.
 
-    :returns: TODO
+    :returns: result of requested command
 
     :raises errors.Error: OS errors triggered by wrong permissions
+    :raises errors.Error: error if plugin command is not supported
 
     """
     log.pre_arg_parse_setup()

From 4d60f32865ceedc7a39f0f74cfe53445f7610fb4 Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Sun, 12 Nov 2017 13:03:09 +0100
Subject: [PATCH 07/10] Minor corrections to return types for improved
 formatting

---
 certbot/main.py | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 089149858..d30f434c0 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -139,7 +139,7 @@ def _handle_subset_cert_request(config, domains, cert):
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
               action can be: "newcert" | "renew" | "reinstall"
-    :rtype: tuple
+    :rtype: `tuple` of `str`
 
     """
     existing = ", ".join(cert.names())
@@ -184,7 +184,7 @@ def _handle_identical_cert_request(config, lineage):
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
               action can be: "newcert" | "renew" | "reinstall"
-    :rtype: tuple
+    :rtype: `tuple` of `str`
 
     """
     if not lineage.ensure_deployed():
@@ -238,6 +238,7 @@ def _find_lineage_for_domains(config, domains):
     :returns: Two-element tuple containing desired new-certificate behavior as
               a string token ("reinstall", "renew", or "newcert"), plus either
               a RenewableCert instance or `None` if renewal shouldn't occur.
+    :rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None`
 
     :raises errors.Error: If the user would like to rerun the client again.
 
@@ -275,6 +276,8 @@ def _find_cert(config, domains, certname):
     :returns: Two-element tuple of a boolean that indicates if this function should be
               followed by a call to fetch a certificate from the server, and either a
               RenewableCert instance or None.
+    :rtype: `tuple` of `bool` and :class:`storage.RenewableCert` or `None`
+
     """
     action, lineage = _find_lineage_for_domains_and_certname(config, domains, certname)
     if action == "reinstall":
@@ -297,6 +300,8 @@ def _find_lineage_for_domains_and_certname(config, domains, certname):
               a string token ("reinstall", "renew", or "newcert"), plus either
               a RenewableCert instance or None if renewal should not occur.
 
+    :rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None`
+
     :raises errors.Error: If the user would like to rerun the client again.
 
     """
@@ -366,7 +371,7 @@ def _find_domains_or_certname(config, installer):
 
 
     :returns: Two-part tuple of domains and certname
-    :rtype: tuple
+    :rtype: `tuple` of list of `str` and `str`
 
     :raises errors.Error: Usage message, if parameters are not used correctly
 
@@ -446,7 +451,7 @@ def _determine_account(config):
 
     :returns: Account and optionally ACME client API (biproduct of new
         registration).
-    :rtype: tuple of certbot.account.Account and acme.client.Client
+    :rtype: tuple of :class:`certbot.account.Account` and :class:`acme.client.Client`
 
     :raises errors.Error: If unable to register an account with ACME server
 
@@ -498,6 +503,9 @@ def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-b
 
     :param `configuration.NamespaceConfig` config: parsed command line arguments
 
+    :returns: `None`
+    :rtype: None
+
     :raises errors.Error: If anything goes wrong, including bad user input, if an overlapping
         archive dir is found for the specified lineage, etc ...
     """
@@ -589,6 +597,7 @@ def _init_le_client(config, authenticator, installer):
     :type installer: interfaces.IInstaller
 
     :returns: client: Client object
+    :rtype: client.Client
 
     """
     if authenticator is not None:
@@ -867,6 +876,7 @@ def certificates(config, unused_plugins):
 
     :returns: `None`
     :rtype: None
+
     """
     cert_manager.certificates(config)
 
@@ -967,7 +977,7 @@ def _csr_get_and_save_cert(config, le_client):
     :type client: client.Client
 
     :returns: `cert_path` and `fullchain_path` as absolute paths to the actual files
-    :rtype: tuple of str
+    :rtype: `tuple` of `str`
 
     """
     csr, _ = config.actual_csr

From 0b843bb8515822bd7f6564180630699d01d3abdb Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Wed, 15 Nov 2017 07:23:34 +0100
Subject: [PATCH 08/10] Added some missing documentation

---
 certbot/main.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/certbot/main.py b/certbot/main.py
index d30f434c0..aeb147e86 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -705,6 +705,24 @@ def register(config, unused_plugins):
     add_msg("Your e-mail address was updated to {0}.".format(config.email))
 
 def _install_cert(config, le_client, domains, lineage=None):
+    """Install a cert
+
+    :param config: Configuration object
+    :type config: interfaces.IConfig
+
+    :param le_client: Client object
+    :type le_client: client.Client
+
+    :param plugins: list of domains
+    :type plugins: `list` of `str`
+
+    :param lineage: certificate lineage object
+    :type lineage: storage.RenewableCert
+
+    :returns: `None`
+    :rtype: None
+
+    """
     path_provider = lineage if lineage else config
     assert path_provider.cert_path is not None
 

From 02126c0961817ba9b87b0864a75c92800fff8e08 Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Wed, 15 Nov 2017 07:24:54 +0100
Subject: [PATCH 09/10] Minor improvement to newly added documentation section

---
 certbot/main.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/certbot/main.py b/certbot/main.py
index aeb147e86..7359b88d5 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -716,7 +716,7 @@ def _install_cert(config, le_client, domains, lineage=None):
     :param plugins: list of domains
     :type plugins: `list` of `str`
 
-    :param lineage: certificate lineage object
+    :param lineage: certificate lineage object. Defaults to `None`
     :type lineage: storage.RenewableCert
 
     :returns: `None`

From e795a79547d65f0965aa4091123214800d40949d Mon Sep 17 00:00:00 2001
From: jonasbn <jonasbn@gmail.com>
Date: Wed, 15 Nov 2017 07:38:09 +0100
Subject: [PATCH 10/10] Lots of minor small cosmetic changes and addressing the
 feedback on uniformity (in the file) from @SwartzCr

---
 certbot/main.py | 71 ++++++++++++++++++++++++++-----------------------
 1 file changed, 37 insertions(+), 34 deletions(-)

diff --git a/certbot/main.py b/certbot/main.py
index 7359b88d5..82063d0db 100644
--- a/certbot/main.py
+++ b/certbot/main.py
@@ -88,13 +88,13 @@ def _get_and_save_cert(le_client, config, domains=None, certname=None, lineage=N
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param domains: domains to get a certificate. Defaults to `None`
+    :param domains: List of domain names to get a certificate. Defaults to `None`
     :type domains: `list` of `str`
 
-    :param certname: Name of new cert. Defaults to `None`
+    :param certname: Name of new certificate. Defaults to `None`
     :type certname: str
 
-    :param lineage:
+    :param lineage: Certificate lineage object. Defaults to `None`
     :type lineage: storage.RenewableCert
 
     :returns: the issued certificate or `None` if doing a dry run
@@ -131,10 +131,10 @@ def _handle_subset_cert_request(config, domains, cert):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param domains: domains
+    :param domains: List of domain names
     :type domains: `list` of `str`
 
-    :param cert:
+    :param cert: Certificate object
     :type cert: storage.RenewableCert
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
@@ -179,7 +179,7 @@ def _handle_identical_cert_request(config, lineage):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param lineage:
+    :param lineage: Certificate lineage object
     :type lineage: storage.RenewableCert
 
     :returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
@@ -232,7 +232,7 @@ def _find_lineage_for_domains(config, domains):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param domains: domains
+    :param domains: List of domain names
     :type domains: `list` of `str`
 
     :returns: Two-element tuple containing desired new-certificate behavior as
@@ -267,10 +267,10 @@ def _find_cert(config, domains, certname):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param domains: domains
+    :param domains: List of domain names
     :type domains: `list` of `str`
 
-    :param certname: Name of cert
+    :param certname: Name of certificate
     :type certname: str
 
     :returns: Two-element tuple of a boolean that indicates if this function should be
@@ -290,10 +290,10 @@ def _find_lineage_for_domains_and_certname(config, domains, certname):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param domains: domains
+    :param domains: List of domain names
     :type domains: `list` of `str`
 
-    :param certname: Name of cert
+    :param certname: Name of certificate
     :type certname: str
 
     :returns: Two-element tuple containing desired new-certificate behavior as
@@ -331,13 +331,13 @@ def _ask_user_to_confirm_new_names(config, new_domains, certname, old_domains):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param new_domains: domains
+    :param new_domains: List of new domain names
     :type new_domains: `list` of `str`
 
-    :param certname: Name of cert
+    :param certname: Name of certificate
     :type certname: str
 
-    :param old_domains: domains
+    :param old_domains: List of old domain names
     :type old_domains: `list` of `str`
 
     :returns: None
@@ -402,10 +402,12 @@ def _find_domains_or_certname(config, installer):
 def _report_new_cert(config, cert_path, fullchain_path, key_path=None):
     """Reports the creation of a new certificate to the user.
 
-    :param cert_path: path to cert
+    :param cert_path: path to certificate
     :type cert_path: str
+
     :param fullchain_path: path to full chain
     :type fullchain_path: str
+
     :param key_path: path to private key, if available
     :type key_path: str
 
@@ -501,7 +503,8 @@ def _delete_if_appropriate(config): # pylint: disable=too-many-locals,too-many-b
     deleting happens automatically, unless if both `--cert-name` and `--cert-path` were
     specified with conflicting values.
 
-    :param `configuration.NamespaceConfig` config: parsed command line arguments
+    :param config: parsed command line arguments
+    :type config: interfaces.IConfig
 
     :returns: `None`
     :rtype: None
@@ -618,7 +621,7 @@ def unregister(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -658,7 +661,7 @@ def register(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None` or a string indicating and error
@@ -713,10 +716,10 @@ def _install_cert(config, le_client, domains, lineage=None):
     :param le_client: Client object
     :type le_client: client.Client
 
-    :param plugins: list of domains
+    :param plugins: List of domains
     :type plugins: `list` of `str`
 
-    :param lineage: certificate lineage object. Defaults to `None`
+    :param lineage: Certificate lineage object. Defaults to `None`
     :type lineage: storage.RenewableCert
 
     :returns: `None`
@@ -736,7 +739,7 @@ def install(config, plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
     :returns: `None`
@@ -763,7 +766,7 @@ def plugins_cmd(config, plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
     :returns: `None`
@@ -802,7 +805,7 @@ def rollback(config, plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
     :returns: `None`
@@ -820,7 +823,7 @@ def config_changes(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -838,7 +841,7 @@ def update_symlinks(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -856,7 +859,7 @@ def rename(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -874,7 +877,7 @@ def delete(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -889,7 +892,7 @@ def certificates(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`
@@ -904,7 +907,7 @@ def revoke(config, unused_plugins):  # TODO: coop with renewal config
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None` or string indicating error in case of error
@@ -941,7 +944,7 @@ def run(config, plugins):  # pylint: disable=too-many-branches,too-many-locals
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
     :returns: `None`
@@ -1014,10 +1017,10 @@ def renew_cert(config, plugins, lineage):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
-    :param lineage: certificate lineage object
+    :param lineage: Certificate lineage object
     :type lineage: storage.RenewableCert
 
     :returns: `None`
@@ -1057,7 +1060,7 @@ def certonly(config, plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param plugins: list of plugins
+    :param plugins: List of plugins
     :type plugins: `list` of `str`
 
     :returns: `None`
@@ -1104,7 +1107,7 @@ def renew(config, unused_plugins):
     :param config: Configuration object
     :type config: interfaces.IConfig
 
-    :param unused_plugins: list of plugins (deprecated)
+    :param unused_plugins: List of plugins (deprecated)
     :type unused_plugins: `list` of `str`
 
     :returns: `None`