Skip to content

fix a few docstrings #5

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 13, 2020
Merged

fix a few docstrings #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions bmipy/bmi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ def get_time_units(self) -> str:

Returns
-------
float
str
The model time unit; e.g., `days` or `s`.

Notes
Expand Down Expand Up @@ -380,7 +380,7 @@ def get_value_at_indices(
An input or output variable name, a CSDMS Standard Name.
dest : ndarray
A numpy array into which to place the values.
indices : array_like
inds : array_like
The indices into the variable array.

Returns
Expand All @@ -401,7 +401,7 @@ def set_value(self, name: str, values: np.ndarray) -> None:

Parameters
----------
var_name : str
name : str
An input or output variable name, a CSDMS Standard Name.
src : array_like
The new value for the specified variable.
Expand All @@ -416,9 +416,9 @@ def set_value_at_indices(

Parameters
----------
var_name : str
name : str
An input or output variable name, a CSDMS Standard Name.
indices : array_like
inds : array_like
The indices into the variable array.
src : array_like
The new value for the specified variable.
Expand Down