Skip to content

Commit

Permalink
Rebuilt docs for status command
Browse files Browse the repository at this point in the history
  • Loading branch information
@markgw
markgw committed Oct 26, 2020
1 parent 571e173 commit c6c52d5
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions docs/commands/status.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Usage:

::

pimlico.sh [...] status [module_name] [-h] [--all] [--short] [--history] [--deps-of DEPS_OF] [--no-color]
pimlico.sh [...] status [module_name] [-h] [--all] [--short] [--history] [--deps-of DEPS_OF] [--no-color] [--no-sections] [--expand-all] [--expand [EXPAND [EXPAND ...]]]


Positional arguments
Expand All @@ -28,17 +28,23 @@ Positional arguments
Options
=======

+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+==========================+=========================================================================================================================================================================================================================================+
| ``--all``, ``-a`` | Show all modules defined in the pipeline, not just those that can be executed |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--short``, ``-s`` | Use a brief format when showing the full pipeline's status. Only applies when module names are not specified. This is useful with very large pipelines, where you just want a compact overview of the status |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--history``, ``-i`` | When a module name is given, even more detailed output is given, including the full execution history of the module |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--deps-of``, ``-d`` | Restrict to showing only the named/numbered module and any that are (transitive) dependencies of it. That is, show the whole tree of modules that lead through the pipeline to the given module |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-color``, ``--nc`` | Don't include terminal color characters, even if the terminal appears to support them. This can be useful if the automatic detection of color terminals doesn't work and the status command displays lots of horrible escape characters |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+=============================+=========================================================================================================================================================================================================================================+
| ``--all``, ``-a`` | Show all modules defined in the pipeline, not just those that can be executed |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--short``, ``-s`` | Use a brief format when showing the full pipeline's status. Only applies when module names are not specified. This is useful with very large pipelines, where you just want a compact overview of the status |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--history``, ``-i`` | When a module name is given, even more detailed output is given, including the full execution history of the module |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--deps-of``, ``-d`` | Restrict to showing only the named/numbered module and any that are (transitive) dependencies of it. That is, show the whole tree of modules that lead through the pipeline to the given module |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-color``, ``--nc`` | Don't include terminal color characters, even if the terminal appears to support them. This can be useful if the automatic detection of color terminals doesn't work and the status command displays lots of horrible escape characters |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-sections``, ``--ns`` | Don't show section headings, but just a list of all the modules |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--expand-all``, ``--xa`` | Show section headings, expanding all |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--expand``, ``-x`` | Expand this section number. May be used multiple times. Give a section number like '1.2.3'. To expand the full subtree, give '1.2.3.' |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0 comments on commit c6c52d5

Please sign in to comment.