cli: fix docstrings about config dir

sopel/cli/config.py

@@ -62,20 +62,24 @@ def build_parser():
 
 
 def handle_list(options):
-    """Display a list of configuration available from Sopel's config directory
+    """Display a list of configurations available in Sopel's config directory.
 
     :param options: parsed arguments
     :type options: ``argparse.Namespace``
 
     This command displays an unordered list of config names from Sopel's
-    default config directory, without their extensions::
+    config directory, without their extensions::
 
         $ sopel-config list
         default
         custom
 
-    It is possible to filter by extension using the ``-e``/``--ext``/``--extension``
-    option; default is ``.cfg`` (the ``.`` prefix is not required).
+    By default, the config directory is ``~/.sopel``. To select a different
+    config directory, options ``--config-dir`` can be used.
+
+    It is possible to filter by extension using the
+    ``-e``/``--ext``/``--extension`` option; default is ``.cfg``
+    (the ``.`` prefix is not required).
     """
     configdir = options.configdir
     display_path = options.display_path

sopel/cli/run.py

@@ -295,7 +295,7 @@ def print_version():
 
 
 def print_config(configdir):
-    """Print list of available configurations from default config directory."""
+    """Print list of available configurations from config directory."""
     configs = utils.enumerate_configs(configdir)
     print('Config files in %s:' % configdir)
     configfile = None

sopel/cli/utils.py

@@ -316,9 +316,11 @@ def load_settings(options):
 
     .. note::
 
-        To use this function effectively, the
-        :func:`sopel.cli.utils.add_common_arguments` function should be used to
-        add the proper option to the argument parser.
+        This function expects that ``options`` exposes two attributes:
+        ``config`` and ``configdir``.
+
+        The :func:`sopel.cli.utils.add_common_arguments` function should be
+        used to add these options to the argument parser.
 
     """
     # Default if no options.config or no env var or if they are empty
@@ -328,8 +330,7 @@ def load_settings(options):
     elif 'SOPEL_CONFIG' in os.environ:
         name = os.environ['SOPEL_CONFIG'] or name  # use default if empty
 
-    filename = find_config(
-        getattr(options, 'configdir', config.DEFAULT_HOMEDIR), name)
+    filename = find_config(options.configdir, name)
 
     if not os.path.isfile(filename):
         raise config.ConfigurationNotFound(filename=filename)

test/cli/test_cli_utils.py

@@ -130,7 +130,10 @@ def test_add_common_arguments():
 
 
 def test_add_common_arguments_subparser():
-    """Assert function adds the -c/--config option on a subparser."""
+    """Assert function adds the multiple options on a subparser.
+
+    The expected options are -c/--config and --config-dir.
+    """
     parser = argparse.ArgumentParser()
     subparsers = parser.add_subparsers(dest='action')
     sub = subparsers.add_parser('sub')