jamie/ptulsconv
1
0
Fork 0
mirror of https://github.com/iluvcapra/ptulsconv.git synced 2026-01-01 17:30:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc twiddle

Browse Source
This commit is contained in:
Jamie Hardt
2022-11-18 18:44:41 -08:00
parent cb6c0c8895
commit a7d01779bd
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/cli_reference.rst
View File

@@ -12,10 +12,10 @@ Invocations of ptulsconv take the following form:
Flags Flags
----- -----
`-h`, `--help`: `-h`, `--help`
Show the help message. Show the help message.
`f FMT`, `--format=FMT`: `f FMT`, `--format=FMT`
Select the output format. By default this is `doc`, which will Select the output format. By default this is `doc`, which will
generate :ref:`ADR reports<adr-reports>`. generate :ref:`ADR reports<adr-reports>`.
@@ -29,10 +29,10 @@ Informational Options
These options display information and exit without processing any These options display information and exit without processing any
input documents. input documents.
`--show-formats`: `--show-formats`
Display information about available output formats. Display information about available output formats.
`--show-available-tags`: `--show-available-tags`
Display information about tags that are used by the Display information about tags that are used by the
report generator. report generator.
@@ -58,8 +58,8 @@ processing is done.
.. _tagged-output: .. _tagged-output:
`tagged` Output: `tagged` Output
"""""""""""""""" """""""""""""""
The "tagged" output format is also a JSON document based on the parsed input data, after the additional The "tagged" output format is also a JSON document based on the parsed input data, after the additional
step of processing all of the :ref:`tags<tags>` in the document. step of processing all of the :ref:`tags<tags>` in the document.