Add documentation for --show history.

lsst · Mar 2, 2020 · 63c94e9 · 63c94e9
1 parent 0ae078d
commit 63c94e9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/doc/lsst.pipe.base/command-line-task-argument-reference.rst b/doc/lsst.pipe.base/command-line-task-argument-reference.rst
@@ -224,15 +224,17 @@ Other named arguments are optional.
 
    See :doc:`command-line-task-data-repo-howto` for more information.
 
-.. option:: --show <config|data|tasks|run>
+.. option:: --show <config|history|data|tasks|run>
 
    **Print metadata without processing.**
 
    Permitted values are:
 
-   - ``config``: show configuration state.
+   - ``config``: show configuration state; add ``=PATTERN`` to limit to configuration entries matching the glob pattern.
 
-   - ``data``: show data IDs resolved by the :option:`--id` argument
+   - ``history=PATTERN``: show where the configuration entries that match the glob pattern were set.
+
+   - ``data``: show data IDs resolved by the :option:`--id` argument.
 
    - ``tasks``: show sub-tasks run by the command-line task.
 

diff --git a/python/lsst/pipe/base/argumentParser.py b/python/lsst/pipe/base/argumentParser.py
@@ -477,7 +477,8 @@ def __init__(self, name, usage="%(prog)s input [options]", **kwargs):
         self.add_argument("--profile", help="Dump cProfile statistics to filename")
         self.add_argument("--show", nargs="+", default=(),
                           help="display the specified information to stdout and quit "
-                               "(unless run is specified).")
+                               "(unless run is specified); information is "
+                               "(config[=PATTERN]|history=PATTERN|tasks|data|run)")
         self.add_argument("-j", "--processes", type=int, default=1, help="Number of processes to use")
         self.add_argument("-t", "--timeout", type=float,
                           help="Timeout for multiprocessing; maximum wall time (sec)")