Add docstrings to config module (#44)

lagru · web-flow · commit 137b8591e146 · 2023-10-03T07:47:22.000-07:00
Didn't push them to #30 in time.
diff --git a/src/changelist/_config.py b/src/changelist/_config.py
@@ -10,13 +10,11 @@
 
 logger = logging.getLogger(__name__)
 
-here = Path(__file__)
-
-
-DEFAULT_CONFIG_PATH = here.parent / "default_config.toml"
+DEFAULT_CONFIG_PATH = Path(__file__).parent / "default_config.toml"
 
 
 def remote_config(gh: Github, org_repo: str, *, rev: str):
+    """Return configuration options in remote pyproject.toml if they exist."""
     repo = gh.get_repo(org_repo)
     try:
         file = repo.get_contents("pyproject.toml", ref=rev)
@@ -30,6 +28,7 @@ def remote_config(gh: Github, org_repo: str, *, rev: str):
 
 
 def local_config(path: Path) -> dict:
+    """Return configuration options in local TOML file if they exist."""
     with path.open("rb") as fp:
         config = tomllib.load(fp)
     config = config.get("tool", {}).get("changelist", {})
@@ -39,6 +38,11 @@ def local_config(path: Path) -> dict:
 def add_config_defaults(
     config: dict, *, default_config_path: Path = DEFAULT_CONFIG_PATH
 ) -> dict:
+    """Fill in default config options if they don't exist in `config`.
+
+    The options are taken from the TOML file given in `default_config_path`.
+    Collections such as lists aren't merged.
+    """
     with default_config_path.open("rb") as fp:
         defaults = tomllib.load(fp)
     defaults = defaults["tool"]["changelist"]
