Update worker main() function docstrings (#287)

* Update worker main() function docstrings Remove non-informative "Set up and run the worker." line at the beginning. * Add worker main() function docstrings
SalishSeaCast · Jul 23, 2024 · f0cf475 · f0cf475
1 parent 30a63dd
commit f0cf475
Show file tree

Hide file tree

Showing 34 changed files with 49 additions and 87 deletions.
diff --git a/nowcast/workers/archive_tarball.py b/nowcast/workers/archive_tarball.py
@@ -39,6 +39,10 @@
 
 
 def main():
+    """For command-line usage see:
+
+    :command:`python -m nowcast.workers.archive_tarball --help`
+    """
     worker = NowcastWorker(NAME, description=__doc__)
     worker.init_cli()
     worker.cli.add_argument(

diff --git a/nowcast/workers/collect_NeahBay_ssh.py b/nowcast/workers/collect_NeahBay_ssh.py
@@ -30,9 +30,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.collect_NeahBay_ssh --help`
     """

diff --git a/nowcast/workers/collect_weather.py b/nowcast/workers/collect_weather.py
@@ -33,9 +33,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.collect_weather --help`
     """

diff --git a/nowcast/workers/download_fvcom_results.py b/nowcast/workers/download_fvcom_results.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.download_fvcom_results --help`
     """

diff --git a/nowcast/workers/download_live_ocean.py b/nowcast/workers/download_live_ocean.py
@@ -41,9 +41,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.download_live_ocean -h`
     """

diff --git a/nowcast/workers/download_results.py b/nowcast/workers/download_results.py
@@ -35,6 +35,10 @@
 
 
 def main():
+    """For command-line usage see:
+
+    :command:`python -m nowcast.workers.download_results --help`
+    """
     worker = NowcastWorker(NAME, description=__doc__)
     worker.init_cli()
     worker.cli.add_argument(

diff --git a/nowcast/workers/download_wwatch3_results.py b/nowcast/workers/download_wwatch3_results.py
@@ -30,6 +30,10 @@
 
 
 def main():
+    """For command-line usage see:
+
+    :command:`python -m nowcast.workers.download_wwatch3_results --help`
+    """
     worker = NowcastWorker(NAME, description=__doc__)
     worker.init_cli()
     worker.cli.add_argument(

diff --git a/nowcast/workers/get_onc_ferry.py b/nowcast/workers/get_onc_ferry.py
@@ -45,9 +45,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.get_onc_ferry -h`
     """

diff --git a/nowcast/workers/launch_remote_worker.py b/nowcast/workers/launch_remote_worker.py
@@ -27,9 +27,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.launch_remote_worker --help`
     """

diff --git a/nowcast/workers/make_CHS_currents_file.py b/nowcast/workers/make_CHS_currents_file.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_CHS_currents_file --help`
     """

diff --git a/nowcast/workers/make_feeds.py b/nowcast/workers/make_feeds.py
@@ -37,6 +37,10 @@
 
 
 def main():
+    """For command-line usage see:
+
+    :command:`python -m nowcast.workers.make_feeds --help`
+    """
     worker = NowcastWorker(NAME, description=__doc__)
     worker.init_cli()
     worker.cli.add_argument(

diff --git a/nowcast/workers/make_forcing_links.py b/nowcast/workers/make_forcing_links.py
@@ -32,9 +32,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_forcing_links --help`
     """

diff --git a/nowcast/workers/make_fvcom_atmos_forcing.py b/nowcast/workers/make_fvcom_atmos_forcing.py
@@ -30,9 +30,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_fvcom_atmos_forcing --help`
     """

diff --git a/nowcast/workers/make_fvcom_boundary.py b/nowcast/workers/make_fvcom_boundary.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_fvcom_boundary --help`
     """

diff --git a/nowcast/workers/make_fvcom_rivers_forcing.py b/nowcast/workers/make_fvcom_rivers_forcing.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_fvcom_rivers_forcing --help`
     """

diff --git a/nowcast/workers/make_runoff_file.py b/nowcast/workers/make_runoff_file.py
@@ -36,9 +36,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_runoff_file --help`
     """

diff --git a/nowcast/workers/make_ssh_files.py b/nowcast/workers/make_ssh_files.py
@@ -37,9 +37,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_ssh_file --help`
     """

diff --git a/nowcast/workers/make_turbidity_file.py b/nowcast/workers/make_turbidity_file.py
@@ -37,9 +37,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.make_turbidity_file --help`
     """

diff --git a/nowcast/workers/ping_erddap.py b/nowcast/workers/ping_erddap.py
@@ -25,9 +25,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.ping_erddap --help`
     """

diff --git a/nowcast/workers/rotate_hindcast_logs.py b/nowcast/workers/rotate_hindcast_logs.py
@@ -39,6 +39,10 @@
 
 
 def main():
+    """For command-line usage see:
+
+    :command:`python -m nowcast.workers.rotate_hindcast_logs --help`
+    """
     worker = NowcastWorker(NAME, description=__doc__)
     worker.init_cli()
     worker.run(rotate_hindcast_logs, success, failure)

diff --git a/nowcast/workers/run_NEMO.py b/nowcast/workers/run_NEMO.py
@@ -36,9 +36,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.run_NEMO --help`
     """

diff --git a/nowcast/workers/run_NEMO_agrif.py b/nowcast/workers/run_NEMO_agrif.py
@@ -34,9 +34,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.run_NEMO_agrif --help`
     """

diff --git a/nowcast/workers/run_NEMO_hindcast.py b/nowcast/workers/run_NEMO_hindcast.py
@@ -34,9 +34,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.run_NEMO_hindcast --help`
     """

diff --git a/nowcast/workers/run_fvcom.py b/nowcast/workers/run_fvcom.py
@@ -39,9 +39,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.run_fvcom --help`
     """

diff --git a/nowcast/workers/run_ww3.py b/nowcast/workers/run_ww3.py
@@ -32,9 +32,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.run_ww3 --help`
     """

diff --git a/nowcast/workers/split_results.py b/nowcast/workers/split_results.py
@@ -32,9 +32,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.split_results --help`
     """

diff --git a/nowcast/workers/update_forecast_datasets.py b/nowcast/workers/update_forecast_datasets.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.update_forecast_datasets -h`
     """

diff --git a/nowcast/workers/upload_forcing.py b/nowcast/workers/upload_forcing.py
@@ -35,9 +35,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.upload_forcing --help`
     """

diff --git a/nowcast/workers/upload_fvcom_atmos_forcing.py b/nowcast/workers/upload_fvcom_atmos_forcing.py
@@ -29,9 +29,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.upload_fvcom_atmos_forcing --help`
     """

diff --git a/nowcast/workers/watch_NEMO.py b/nowcast/workers/watch_NEMO.py
@@ -33,9 +33,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.watch_NEMO --help`
     """

diff --git a/nowcast/workers/watch_NEMO_agrif.py b/nowcast/workers/watch_NEMO_agrif.py
@@ -33,9 +33,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.watch_NEMO_agrif --help`
     """

diff --git a/nowcast/workers/watch_NEMO_hindcast.py b/nowcast/workers/watch_NEMO_hindcast.py
@@ -33,9 +33,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.watch_NEMO_hindcast --help`
     """

diff --git a/nowcast/workers/watch_fvcom.py b/nowcast/workers/watch_fvcom.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.watch_fvcom --help`
     """

diff --git a/nowcast/workers/watch_ww3.py b/nowcast/workers/watch_ww3.py
@@ -31,9 +31,7 @@
 
 
 def main():
-    """Set up and run the worker.
-
-    For command-line usage see:
+    """For command-line usage see:
 
     :command:`python -m nowcast.workers.watch_ww3 --help`
     """