Skip to content

Commit b153e8d

Browse files
committed
Make docstring of function better understandable
1 parent 0a386a1 commit b153e8d

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

tests/test_wind_turbine.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ def test_error_raising(self):
3434
def test_get_turbine_data_from_file(self):
3535
# Raise FileNotFoundError due to missing
3636
with pytest.raises(FileNotFoundError):
37-
get_turbine_data_from_file(turbine_type='...', file_='not_existent')
37+
get_turbine_data_from_file(turbine_type='...',
38+
file_='not_existent')
3839

3940
def test_get_turbine_types(self):
4041
get_turbine_types(print_out=False)

windpowerlib/wind_turbine.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ def isfloat(x):
266266

267267
def get_turbine_data_from_oedb(turbine_type, fetch_curve):
268268
r"""
269-
Gets turbine data from the OpenEnergy Database (oedb).
269+
Fetches data for one wind turbine type from the OpenEnergy Database (oedb).
270270
271271
Parameters
272272
----------
@@ -283,9 +283,9 @@ def get_turbine_data_from_oedb(turbine_type, fetch_curve):
283283
-------
284284
Tuple (pandas.DataFrame, float)
285285
Power curve or power coefficient curve (pandas.DataFrame) and nominal
286-
power (float). Power (coefficient) curve DataFrame contains power
287-
coefficient curve values (dimensionless) or power curve values in W
288-
with the corresponding wind speeds in m/s.
286+
power (float) of one wind turbine type. Power (coefficient) curve
287+
DataFrame contains power coefficient curve values (dimensionless) or
288+
power curve values in W with the corresponding wind speeds in m/s.
289289
290290
"""
291291
# Extract data

0 commit comments

Comments
 (0)