[PATCH 3/9] doc: reword argparse section in prog guide
Stephen Hemminger
stephen at networkplumber.org
Mon May 13 21:01:18 CEST 2024
On Mon, 13 May 2024 08:59:05 -0700
Nandini Persad <nandinipersad361 at gmail.com> wrote:
> @@ -132,15 +131,15 @@ their values are parsing in the order defined.
> The compact mode is not supported.
> Take above "-a" and "-d" as an example, don't support "-ad" input.
>
> -Parsing by autosave way
> +Parsing the Autosave Method
> ~~~~~~~~~~~~~~~~~~~~~~~
RST is picky about the title format.
If you build the docs, this change will generate a warning:
ninja -C build doc
ninja: Entering directory `build'
[4/5] Generating doc/guides/html_guides with a custom command
/home/shemminger/DPDK/doc-rework/doc/guides/contributing/design.rst:41: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/shemminger/DPDK/doc-rework/doc/guides/prog_guide/argparse_lib.rst:135: WARNING: Title underline too short.
Parsing the Autosave Method
~~~~~~~~~~~~~~~~~~~~~~~
/home/shemminger/DPDK/doc-rework/doc/guides/prog_guide/argparse_lib.rst:135: WARNING: Title underline too short.
Parsing the Autosave Method
~~~~~~~~~~~~~~~~~~~~~~~
/home/shemminger/DPDK/doc-rework/doc/guides/prog_guide/argparse_lib.rst:161: WARNING: Title underline too short.
Parsing by Callback Method
~~~~~~~~~
/home/shemminger/DPDK/doc-rework/doc/guides/prog_guide/argparse_lib.rst:161: WARNING: Title underline too short.
Parsing by Callback Method
~~~~~~~~~
[4/5] Running external command doc (wrapped by meson to set env)
Building docs: Doxygen_API(HTML) Doxygen_API(Manpage) HTML_Guides
More information about the dev
mailing list