adds parameters doc string

arfc · Jan 14, 2025 · 801b0a8 · 801b0a8
1 parent 6d6b8dd
commit 801b0a8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'osier'
-copyright = '2022-2024, Samuel Dotson'
+copyright = '2022-2025, Samuel Dotson'
 author = 'Samuel Dotson'
 
 # The full version, including alpha/beta/rc tags

diff --git a/osier/technology.py b/osier/technology.py
@@ -950,7 +950,14 @@ def charge(self, surplus, time_delta=1 * hr):
     def power_output(self, v, time_delta=1 * hr):
         """
         Calculates the power output given a demand value.
-
+        
+        Parameters
+        ----------
+        v : :class:`unyt.unyt_quantity`
+            Voltage representing a demand or a surplus of energy.
+        time_delta : :class:`unyt.unyt_quantity`
+            The real time passed between modeled timesteps.
+        
         Returns
         -------
         output : :class:`unyt.unyt_quantity`