Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doctring update #64

Merged
merged 1 commit into from
Nov 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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