Skip to content

Commit c69f778

Browse files
committed
Add to docstrings
1 parent dc1454e commit c69f778

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

windpowerlib/power_output.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ def power_coefficient_curve(wind_speed, density, rotor_diameter, cp_values):
1616
Calculates the turbine power output using a power coefficient curve.
1717
1818
This function is carried out when the parameter `power_output_model` of an
19-
instance of the :class:`~.modelchain.ModelChain` class
20-
is 'cp_values' and the parameter `density_corr` is False.
19+
instance of the :class:`~.modelchain.ModelChain` class is 'cp_values' and
20+
the parameter `density_corr` is False.
2121
2222
Parameters
2323
----------
@@ -36,6 +36,7 @@ def power_coefficient_curve(wind_speed, density, rotor_diameter, cp_values):
3636
-------
3737
pandas.Series or numpy.array
3838
Electrical power output of the wind turbine in W.
39+
Data type depends on type of `wind_speed`.
3940
4041
Notes
4142
-----
@@ -100,6 +101,7 @@ def cp_curve_density_corr(wind_speed, density, rotor_diameter, cp_values):
100101
-------
101102
pandas.Series or numpy.array
102103
Electrical power of the wind turbine in W.
104+
Data type depends on type of `wind_speed`.
103105
104106
Notes
105107
-----
@@ -140,6 +142,7 @@ def power_curve(wind_speed, p_values):
140142
-------
141143
pandas.Series or numpy.array
142144
Electrical power output of the wind turbine in W.
145+
Data type depends on type of `wind_speed`.
143146
144147
Notes
145148
-------
@@ -179,6 +182,7 @@ def p_curve_density_corr(wind_speed, density, p_values):
179182
-------
180183
pandas.Series or numpy.array
181184
Electrical power output of the wind turbine in W.
185+
Data type depends on type of `wind_speed`.
182186
183187
Notes
184188
-----

windpowerlib/wind_speed.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def logarithmic_profile(wind_speed, wind_speed_height, hub_height,
3939
Returns
4040
-------
4141
pandas.Series or numpy.array
42-
Wind speed at hub height.
42+
Wind speed at hub height. Data type depends on type of `wind_speed`.
4343
4444
Notes
4545
-----
@@ -121,7 +121,7 @@ def hellman(wind_speed, wind_speed_height, hub_height,
121121
Returns
122122
-------
123123
pandas.Series or numpy.array
124-
Wind speed at hub height.
124+
Wind speed at hub height. Data type depends on type of `wind_speed`.
125125
126126
Notes
127127
-----

0 commit comments

Comments
 (0)