mkdocs string

kausalflow · Feb 20, 2024 · 9a50ed0 · 9a50ed0
1 parent 39896d8
commit 9a50ed0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/hamiltonian_flow/models/harmonic_oscillator.py b/hamiltonian_flow/models/harmonic_oscillator.py
@@ -7,7 +7,12 @@
 
 
 class HarmonicOscillatorParams(BaseModel):
-    """The params for the harmonic oscillator"""
+    """The params for the harmonic oscillator
+
+    :param omega: angular frequency of the harmonic oscillator
+    :param amplitude: the amplitude of the oscillation
+    :param phi: initial phase
+    """
 
     omega: float
     amplitude: float = 1.0
@@ -16,11 +21,13 @@ class HarmonicOscillatorParams(BaseModel):
     @computed_field  # type: ignore[misc]
     @cached_property
     def period(self) -> float:
+        """period of the oscillator"""
         return 2 * np.pi / self.omega
 
     @computed_field  # type: ignore[misc]
     @cached_property
     def frequency(self) -> float:
+        """frequency of the oscillator"""
         return 1 / self.period
 
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -62,7 +62,7 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          selection:
+          options:
             docstring_style: sphinx
       watch:
         - docs