Improve docstrings

Author: Gehock

src/zeusops_bot/errors.py

@@ -8,30 +8,30 @@ class ZeusopsBotException(Exception):
 
 
 class ZeusopsBotConfigException(ZeusopsBotException):
-    """The bot's config itself is wrong somehow"""
+    """The Discord bot config itself is wrong somehow"""
 
     pass
 
 
 class BadConfigFileException(ZeusopsBotException):
-    """The config file given is incorrect somehow"""
+    """The Reforger config file given is incorrect somehow"""
 
     pass
 
 
 class ConfigFileNotFound(BadConfigFileException):
-    """The config file was not found at given path"""
+    """The Reforger config file was not found at given path"""
 
     pass
 
 
 class ConfigFileInvalidJson(BadConfigFileException):
-    """The config file was found but isn't valid JSON"""
+    """The Reforger config file was found but isn't valid JSON"""
 
     pass
 
 
 class ConfigPatchingError(BadConfigFileException):
-    """The config file patching didn't work"""
+    """The Reforger config file patching didn't work"""
 
     pass

src/zeusops_bot/reforger_config_gen.py

@@ -24,7 +24,12 @@ class ReforgerConfigGenerator:
     """Manages Arma Reforger config.json for variations of modlist/scenario"""
 
     def __init__(self, base_config_file: Path, target_folder: Path):
-        """Instantiate a config generator with the base config to use"""
+        """Instantiate a config generator with the base config to use
+
+        Args:
+          base_config_file: The filename of a reference Reforger config
+          target_folder: The folder to place generated config files in
+        """
         self.base_config = base_config_file
         self.target_dest = target_folder
 
@@ -109,6 +114,10 @@ def current_mission(self) -> str:
 
         Returns:
           Currently active mission name
+
+        Raises:
+          ConfigFileNotFound: Mission symlink was found but points to a
+                              non-existent mission.
         """
         symlink_path = self.target_dest / SYMLINK_FILENAME
         target = symlink_path.readlink()
@@ -145,7 +154,20 @@ def patch_file(source: dict, modlist: list[ModDetail] | None, scenario_id: str)
 
 
 def extract_mods(modlist: str | None) -> list[ModDetail] | None:
-    """Extracts a list of ModDetail entries from a mod list exported from Reforger."""
+    """Extracts a list of ModDetail entries from a mod list exported from Reforger
+
+    Args:
+      modlist: A partial JSON string of mods to extract. Can be None if the
+               user did not provide any mods, in which case the operation is a
+               no-op.
+
+    Raises:
+      pydantic.ValidationError: Generic error in validating the mod list
+      ConfigFileInvalidJson: The input was not valid JSON
+
+    Returns:
+      A list of ModDetail, or None if the input was None.
+    """
     if modlist is None:
         return None
     modlist = f"[{modlist}]"