Merge pull request #64 from fema-ffrd/63-observed-input-data-docstring

doctring update
fema-ffrd · Nov 26, 2024 · 5ba9237 · 5ba9237
2 parents f84eb44 + f7759b1
commit 5ba9237
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/rashdf/plan.py b/src/rashdf/plan.py
@@ -1121,7 +1121,7 @@ def reference_lines_timeseries_output(self) -> xr.Dataset:
         """
         return self.reference_timeseries_output(reftype="lines")
 
-    def observed_timeseries_input(self, vartype: str = "Flow") -> dict:
+    def observed_timeseries_input(self, vartype: str = "Flow") -> xr.DataArray:
         """Return observed timeseries input data for reference lines and points from a HEC-RAS HDF plan file.
 
         Parameters
@@ -1132,8 +1132,8 @@ def observed_timeseries_input(self, vartype: str = "Flow") -> dict:
 
         Returns
         -------
-        xr.Dataset
-            An xarray Dataset with observed timeseries input data for both reference lines and reference points.
+        xr.DataArray
+            An xarray DataArray with observed timeseries input data for reference lines or reference points.
         """
         if vartype == "Flow":
             output_path = self.OBS_FLOW_OUTPUT_PATH