Skip to content

Commit

Permalink
Correcting typos within the docstring related to the observed time se…
Browse files Browse the repository at this point in the history
…ries input data function
  • Loading branch information
zherbz committed Nov 26, 2024
1 parent f84eb44 commit f7759b1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/rashdf/plan.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit f7759b1

Please sign in to comment.