updated doc strings for new function

fema-ffrd · Oct 23, 2024 · e4d9469 · e4d9469
1 parent 42a3e20
commit e4d9469
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/rashdf/plan.py b/src/rashdf/plan.py
@@ -1129,7 +1129,15 @@ def observed_timeseries_output(self, vartype: str = "Flow") -> xr.Dataset:
         Returns
         -------
         xr.Dataset
-            An xarray Dataset with reference line timeseries data.
+            An xarray Dataset with observed timeseries data for both reference lines and reference points.
+
+            Coordinates:
+            - 'time': datetime64[ns]
+            - 'obs_name': object
+
+            Data variables:
+            - 'Flow': (obs_name, time) float64
+            - 'Stage': (obs_name, time) float64
         """
 
         # Decode the contents of the DataFrame from utf-8