Add worker main() function docstrings

SalishSeaCast · Jul 23, 2024 · a182b82 · a182b82
1 parent acba210
commit a182b82
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 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/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/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/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)