Skip to content

Commit 9941d7e

Browse files
authored
Merge pull request #37 from BSchilperoort/master
Change list to tuple in get_*_var_names docstring
2 parents 793f566 + c9425da commit 9941d7e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/bmipy/bmi.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ def get_output_item_count(self) -> int:
103103
...
104104

105105
@abstractmethod
106-
def get_input_var_names(self) -> tuple[str]:
107-
"""List of a model's input variables.
106+
def get_input_var_names(self) -> tuple[str, ...]:
107+
"""Get the model's input variables.
108108
109109
Input variable names must be CSDMS Standard Names, also known
110110
as *long variable names*.
111111
112112
Returns
113113
-------
114-
list of str
114+
tuple of str
115115
The input variables for the model.
116116
117117
Notes
@@ -126,15 +126,15 @@ def get_input_var_names(self) -> tuple[str]:
126126
...
127127

128128
@abstractmethod
129-
def get_output_var_names(self) -> tuple[str]:
130-
"""List of a model's output variables.
129+
def get_output_var_names(self) -> tuple[str, ...]:
130+
"""Get the model's output variables.
131131
132132
Output variable names must be CSDMS Standard Names, also known
133133
as *long variable names*.
134134
135135
Returns
136136
-------
137-
list of str
137+
tuple of str
138138
The output variables for the model.
139139
"""
140140
...

0 commit comments

Comments
 (0)