Skip to content

Commit cc2b380

Browse files
committed
Add default value to docstring
1 parent 303707b commit cc2b380

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

windpowerlib/wind_turbine.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,8 @@ def to_group(self, number_turbines=None, total_capacity=None):
224224
r"""
225225
Creates a :class:`~windpowerlib.wind_turbine.WindTurbineGroup`, a
226226
NamedTuple data container with the fields 'number_of_turbines' and
227-
'wind_turbine'.
227+
'wind_turbine'. If no parameter is passed the number of turbines is
228+
set to one.
228229
229230
It can be used to calculate the number of turbines for a given total
230231
capacity or to create a namedtuple that can be used to define a
@@ -233,7 +234,7 @@ def to_group(self, number_turbines=None, total_capacity=None):
233234
Parameters
234235
----------
235236
number_turbines : float
236-
Number of turbines of the defined type.
237+
Number of turbines of the defined type. Default: 1
237238
total_capacity : float
238239
Total capacity of the group of wind turbines of the same type.
239240

0 commit comments

Comments
 (0)