Skip to content

Commit 7e41a93

Browse files
amotlgutzbenj
authored andcommitted
CLI: Improve help text by making examples work
1 parent 7aac99d commit 7e41a93

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

docs/usage/cli.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -185,25 +185,29 @@ Command Line Interface
185185
# The real power horse: Acquire data across historical+recent data sets
186186
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=daily --date=1969-01-01/2020-06-11 --station=1048
187187

188-
# Acquire monthly data for 2020-05
189-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --date=2020-05 --station=1048
188+
# Acquire single data point for month 2020-05
189+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --tidy \
190+
--date=2020-05 --station=1048
190191

191-
# Acquire monthly data from 2017-01 to 2019-12
192-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --date=2017-01/2019-12 --station=1048,4411
192+
# Acquire monthly data from 2017 to 2019
193+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --tidy \
194+
--date=2017/2019 --station=1048,4411
193195

194196
# Acquire annual data for 2019
195-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --date=2019 --station=1048,4411
197+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --tidy \
198+
--date=2019 --station=1048,4411
196199

197200
# Acquire annual data from 2010 to 2020
198-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --date=2010/2020 --station=1048
201+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --tidy \
202+
--date=2010/2020 --station=1048
199203

200204
# Acquire hourly data for a given time range
201205
wetterdienst values --provider=dwd --network=observation --parameter=air_temperature --resolution=hourly \
202206
--date=2020-06-15T12/2020-06-16T12 --station=1048,4411
203207

204-
# Acquire data for specific parameter and dataset
208+
# Acquire data for multiple given parameters
205209
wetterdienst values --provider=dwd --network=observation \
206-
--parameter=precipitation_height/precipitation_more,temperature_air_200/kl \
210+
--parameter=precipitation_height/precipitation_more,temperature_air_mean_200/air_temperature \
207211
--resolution=hourly --date=2020-06-15T12/2020-06-16T12 --station=1048,4411
208212

209213
Acquire MOSMIX data:

wetterdienst/ui/cli.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -327,25 +327,29 @@ def wetterdienst_help():
327327
# The real power horse: Acquire data across historical+recent data sets
328328
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=daily --date=1969-01-01/2020-06-11 --station=1048
329329
330-
# Acquire monthly data for 2020-05
331-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --date=2020-05 --station=1048
330+
# Acquire single data point for month 2020-05
331+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --tidy \\
332+
--date=2020-05 --station=1048
332333
333-
# Acquire monthly data from 2017-01 to 2019-12
334-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --date=2017-01/2019-12 --station=1048,4411
334+
# Acquire monthly data from 2017 to 2019
335+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=monthly --tidy \\
336+
--date=2017/2019 --station=1048,4411
335337
336338
# Acquire annual data for 2019
337-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --date=2019 --station=1048,4411
339+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --tidy \\
340+
--date=2019 --station=1048,4411
338341
339342
# Acquire annual data from 2010 to 2020
340-
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --date=2010/2020 --station=1048
343+
wetterdienst values --provider=dwd --network=observation --parameter=kl --resolution=annual --tidy \\
344+
--date=2010/2020 --station=1048
341345
342346
# Acquire hourly data for a given time range
343347
wetterdienst values --provider=dwd --network=observation --parameter=air_temperature --resolution=hourly \\
344348
--date=2020-06-15T12/2020-06-16T12 --station=1048,4411
345349
346-
# Acquire data for specific parameter and dataset
350+
# Acquire data for multiple given parameters
347351
wetterdienst values --provider=dwd --network=observation \\
348-
--parameter=precipitation_height/precipitation_more,temperature_air_200/kl \\
352+
--parameter=precipitation_height/precipitation_more,temperature_air_mean_200/air_temperature \\
349353
--resolution=hourly --date=2020-06-15T12/2020-06-16T12 --station=1048,4411
350354
351355
Acquire MOSMIX data:

0 commit comments

Comments
 (0)