Skip to content

Change list to tuple in get_*_var_names docstring #37

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 2 commits into from
Nov 22, 2023
Merged

Change list to tuple in get_*_var_names docstring #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a81526
Change list to tuple in get_*_var_names docstring
BSchilperoort Nov 20, 2023
c9425da
Fix tuple of strings type hint
BSchilperoort Nov 22, 2023
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
12 changes: 6 additions & 6 deletions src/bmipy/bmi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,15 @@ def get_output_item_count(self) -> int:
...

@abstractmethod
def get_input_var_names(self) -> tuple[str]:
"""List of a model's input variables.
def get_input_var_names(self) -> tuple[str, ...]:
"""Get the model's input variables.

Input variable names must be CSDMS Standard Names, also known
as *long variable names*.

Returns
-------
list of str
tuple of str
The input variables for the model.

Notes
Expand All @@ -126,15 +126,15 @@ def get_input_var_names(self) -> tuple[str]:
...

@abstractmethod
def get_output_var_names(self) -> tuple[str]:
"""List of a model's output variables.
def get_output_var_names(self) -> tuple[str, ...]:
"""Get the model's output variables.

Output variable names must be CSDMS Standard Names, also known
as *long variable names*.

Returns
-------
list of str
tuple of str
The output variables for the model.
"""
...
Expand Down