Skip to content

Commit 86dc251

Browse files
Birgit SchachlerBirgit Schachler
authored andcommitted
Add inline code markdown
1 parent e2399b2 commit 86dc251

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

example/basic_example.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,19 +104,18 @@ def read_weather_data(filename, datetime_column='time_index',
104104
return (weather, data_height)
105105

106106

107-
# TODO markdown for code snippet
108107
def initialise_wind_turbines():
109108
r"""
110109
Initialises two :class:`~.wind_turbine.WindTurbine` objects.
111110
112111
Function shows two ways to initialise a WindTurbine object. You can either
113112
specify your own turbine, as done below for 'myTurbine', or fetch power
114113
and/or power coefficient curve data from data files provided by the
115-
windpowerlib, as done for the 'enerconE126'. Execute
116-
windpowerlib.wind_turbine.get_turbine_types() or
117-
windpowerlib.wind_turbine.get_turbine_types(filename='cp_curves.csv')
118-
to get a list of all wind turbines for which power or power coefficient
119-
curves, respectively, are provided.
114+
windpowerlib, as done for the 'enerconE126'.
115+
Execute ``windpowerlib.wind_turbine.get_turbine_types()`` or
116+
``windpowerlib.wind_turbine.get_turbine_types(filename='cp_curves.csv')``
117+
to get a list of all wind turbines for which power and power coefficient
118+
curves respectively are provided.
120119
121120
Returns
122121
-------
@@ -251,6 +250,10 @@ def plot_or_print(my_turbine, e126):
251250

252251

253252
def run_basic_example():
253+
r"""
254+
Run the basic example.
255+
256+
"""
254257
weather, data_height = get_weather_data('weather.csv')
255258
my_turbine, e126 = initialise_wind_turbines()
256259
calculate_power_output(weather, data_height, my_turbine, e126)

0 commit comments

Comments
 (0)