Skip to content

Commit 2e3d24a

Browse files
committed
replace array with array-like in the docstrings
1 parent a980ef1 commit 2e3d24a

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

windpowerlib/density.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def temperature_gradient(temp_air, temp_height, hub_height):
2020
2121
Parameters
2222
----------
23-
temp_air : pandas.Series or array
23+
temp_air : pandas.Series or array-like
2424
Air temperature in K.
2525
temp_height : float
2626
Height in m for which the parameter `temp_air` applies.
@@ -70,9 +70,9 @@ def temperature_interpol(temp_air_1, temp_air_2,
7070
7171
Parameters
7272
----------
73-
temp_air_1 : pandas.Series or array
73+
temp_air_1 : pandas.Series or array-like
7474
Air temperature.
75-
temp_air_2 : pandas.Series or array
75+
temp_air_2 : pandas.Series or array-like
7676
Second air temperature for interpolation.
7777
temp_air_height_1 : float
7878
Height for which the parameter `temp_air_1` applies.
@@ -116,13 +116,13 @@ def rho_barometric(pressure, pressure_height, hub_height, temp_hub):
116116
117117
Parameters
118118
----------
119-
pressure : pandas.Series or array
119+
pressure : pandas.Series or array-like
120120
Air pressure in Pa.
121121
pressure_height : float
122122
Height in m for which the parameter `pressure` applies.
123123
hub_height : float
124124
Hub height of wind turbine in m.
125-
temp_hub : pandas.Series or array
125+
temp_hub : pandas.Series or array-like
126126
Air temperature at hub height in K.
127127
128128
Returns
@@ -172,13 +172,13 @@ def rho_ideal_gas(pressure, pressure_height, hub_height, temp_hub):
172172
173173
Parameters
174174
----------
175-
pressure : pandas.Series or array
175+
pressure : pandas.Series or array-like
176176
Air pressure in Pa.
177177
pressure_height : float
178178
Height in m for which the parameter `pressure` applies.
179179
hub_height : float
180180
Hub height of wind turbine in m.
181-
temp_hub : pandas.Series or array
181+
temp_hub : pandas.Series or array-like
182182
Air temperature at hub height in K.
183183
184184
Returns

windpowerlib/power_output.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ def cp_curve(v_wind, rho_hub, d_rotor, cp_values):
2121
2222
Parameters
2323
----------
24-
v_wind : pandas.Series or array
24+
v_wind : pandas.Series or array-like
2525
Wind speed at hub height in m/s.
26-
rho_hub : pandas.Series or array
26+
rho_hub : pandas.Series or array-like
2727
Density of air at hub height in kg/m³.
2828
d_rotor : float
2929
Diameter of rotor in m.
@@ -85,7 +85,7 @@ def cp_curve_density_corr(v_wind, rho_hub, d_rotor, cp_values):
8585
----------
8686
v_wind : pandas.Series or array
8787
Wind speed at hub height in m/s.
88-
rho_hub : pandas.Series or array
88+
rho_hub : pandas.Series or array-like
8989
Density of air at hub height in kg/m³.
9090
cp_values : pandas.DataFrame
9191
Power coefficient curve of the wind turbine.

windpowerlib/wind_speed.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ def logarithmic_wind_profile(v_wind, v_wind_height, hub_height, z_0,
2323
2424
Parameters
2525
----------
26-
v_wind : pandas.Series or array
26+
v_wind : pandas.Series or array-like
2727
Wind speed time series.
2828
v_wind_height : float
2929
Height for which the parameter `v_wind` applies.
3030
hub_height : float
3131
Hub height of wind turbine.
32-
z_0 : pandas.Series or array or float
32+
z_0 : pandas.Series or array-like or float
3333
Roughness length.
3434
obstacle_height : float
3535
Height of obstacles in the surrounding area of the wind turbine. Set
@@ -93,7 +93,7 @@ def v_wind_hellman(v_wind, v_wind_height, hub_height, hellman_exp=None,
9393
9494
Parameters
9595
----------
96-
v_wind : pandas.Series or array
96+
v_wind : pandas.Series or array-like
9797
Wind speed time series.
9898
v_wind_height : float
9999
Height for which the parameter `v_wind` applies.

0 commit comments

Comments
 (0)