Updated runpipeline section on CLI docs (#685)

* Issue #684: updated CLI runpipeline docs * Updated CHANGELOG.md * Narrowed the help output
askap-vast · May 16, 2023 · f2c207c · f2c207c
1 parent 94bfccf
commit f2c207c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -67,6 +67,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### Fixed
 
+- Fixed outdated `runpipeline` section on CLI docs page [#685](https://github.com/askap-vast/vast-pipeline/pull/685).
 - Fixed link to JupyterHub [#676](https://github.com/askap-vast/vast-pipeline/pull/676).
 - Ensure Image models are not created if the catalogue ingest fails [#648](https://github.com/askap-vast/vast-pipeline/pull/648).
 - Fixed run failures caused by attempting to force fit images with empty catalogues [#653](https://github.com/askap-vast/vast-pipeline/pull/653).
@@ -104,6 +105,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### List of PRs
 
+- [#685](https://github.com/askap-vast/vast-pipeline/pull/685): docs: Updated `runpipeline` section on CLI docs.
 - [#676](https://github.com/askap-vast/vast-pipeline/pull/676): Removed home counts and new source count.
 - [#665](https://github.com/askap-vast/vast-pipeline/pull/665): Update Gr1N/setup-poetry to v7.
 - [#658](https://github.com/askap-vast/vast-pipeline/pull/658): feat: Add MAX_CUTOUT_IMAGES setting.

diff --git a/docs/adminusage/cli.md b/docs/adminusage/cli.md
@@ -504,34 +504,42 @@ Would you like to restore the run ? (y/n): y
 
 The pipeline is run using `runpipeline` django command.
 
+The `--full-rerun` option allows for the requested pipeline run to be cleared prior to processing
+so a fresh run is performed.
+
+!!!warning
+    Using `--full-rerun` cannot be undone and all prior results will be deleted, including any source comments
+    associated with the pipeline run.
+    Use with caution.
+
 ```terminal
 (pipeline_env)$ ./manage.py runpipeline --help
 ```
 
 Output:
 
 ```terminal
-usage: manage.py runpipeline [-h] [--version] [-v {0,1,2,3}]
+usage: manage.py runpipeline [-h] [--full-rerun] [--version] [-v {0,1,2,3}]
                              [--settings SETTINGS] [--pythonpath PYTHONPATH]
-                             [--traceback] [--no-color] [--force-color]
-                             [--skip-checks]
+                             [--traceback] [--no-color] [--force-color] [--skip-checks]
                              piperun
 
 Process the pipeline for a list of images and Selavy catalogs
 
 positional arguments:
-  piperun       Path or name of the pipeline run.
+  piperun               Path or name of the pipeline run.
 
 optional arguments:
   -h, --help            show this help message and exit
+  --full-rerun          Flag to signify that a full re-run is requested. Old data is
+                        completely removed and replaced.
   --version             show program's version number and exit
   -v {0,1,2,3}, --verbosity {0,1,2,3}
-                        Verbosity level; 0=minimal output, 1=normal output,
-                        2=verbose output, 3=very verbose output
+                        Verbosity level; 0=minimal output, 1=normal output, 2=verbose
+                        output, 3=very verbose output
   --settings SETTINGS   The Python path to a settings module, e.g.
                         "myproject.settings.main". If this isn't provided, the
-                        DJANGO_SETTINGS_MODULE environment variable will be
-                        used.
+                        DJANGO_SETTINGS_MODULE environment variable will be used.
   --pythonpath PYTHONPATH
                         A directory to add to the Python path, e.g.
                         "/home/djangoprojects/myproject".