Skip to content

Commit 14dee34

Browse files
committed
Adapt docstrings
1 parent 8dd1070 commit 14dee34

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

windpowerlib/wake_losses.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ def reduce_wind_speed(wind_speed, wind_efficiency_curve_name='dena_mean'):
2525
wind_speed : pandas.Series or numpy.array
2626
Wind speed time series.
2727
wind_efficiency_curve_name : string
28-
Name of the wind efficiency curve. Use display_wind_efficiency_curves()
29-
to see all provided wind efficiency curves.
28+
Name of the wind efficiency curve. Use get_wind_efficiency_curve() to
29+
get all provided wind efficiency curves. Default: 'dena_mean'.
3030
3131
Returns
3232
-------
@@ -57,20 +57,21 @@ def reduce_wind_speed(wind_speed, wind_efficiency_curve_name='dena_mean'):
5757

5858
def get_wind_efficiency_curve(curve_name='dena_mean'):
5959
r"""
60-
Reads wind efficiency curve specified in `curve_name`.
60+
Reads wind efficiency curve(s) specified in `curve_name`.
6161
6262
Parameters
6363
----------
6464
curve_name : str or list
65-
Specifies the curve. Use display_wind_efficiency_curves() to see all
66-
provided wind efficiency curves. Default: 'dena_mean'. Use 'all' to
67-
get all curves in a MultiIndex DataFrame.
65+
Specifies the curve. Default: 'dena_mean'. Use 'all' to get all curves
66+
in a MultiIndex DataFrame.
6867
6968
Returns
7069
-------
7170
efficiency_curve : pd.DataFrame
7271
Wind efficiency curve. Contains 'wind_speed' and 'efficiency' columns
7372
with wind speed in m/s and wind efficiency (dimensionless).
73+
If `curve_name` is 'all' or a list of strings a MultiIndex DataFrame is
74+
returned with curve names in the first level of the columns.
7475
7576
Notes
7677
-----

0 commit comments

Comments
 (0)