Add parent Record class to _MonthlyRecord to fix autodoc error

CSHS-CWRA · Feb 11, 2025 · fa48c8f · fa48c8f
1 parent 7e2ed40
commit fa48c8f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -10,6 +10,7 @@ v0.18.0 (unreleased)
     * New `pre-commit` hooks for `vulture` (find dead code) and `codespell` (spelling errors).
     * Removed several `type: ignore` statements.
     * Spelling errors in documentation have been addressed.
+* Fix bug in _MonthlyRecord class definition crashing the pydantic-autodoc serialization. (PR #458)
 
 v0.17.0 (2025-01-27)
 --------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -76,7 +76,7 @@ def rebuild_readme():
     "sphinx_codeautolink",
     "sphinx_copybutton",
     "sphinxcontrib.cairosvgconverter",
-    # "sphinxcontrib.autodoc_pydantic",  # FIXME: Does not seem to be compatible with RavenPy codebase.
+    "sphinxcontrib.autodoc_pydantic",  # FIXME: Does not seem to be compatible with RavenPy codebase.
 ]
 
 linkcheck_ignore = [

diff --git a/src/ravenpy/config/commands.py b/src/ravenpy/config/commands.py
@@ -1077,11 +1077,9 @@ class TerrainClasses(ListCommand):
     _Units: Sequence[str] = PrivateAttr(["m", "km/km2"])
 
 
-class _MonthlyRecord:
+class _MonthlyRecord(Record):
     name: str = "[DEFAULT]"
-    values: Sequence[float] = 12 * [
-        1.0,
-    ]
+    values: Sequence[float] = 12 * [1.0]
 
     def __str__(self):
         return f"{self.name:<16} " + ", ".join(map(str, self.values))