[PATCH v11 05/21] argparse: add documentation on supported value types
Bruce Richardson
bruce.richardson at intel.com
Wed Oct 15 10:40:25 CEST 2025
On Wed, Oct 15, 2025 at 03:53:09PM +0800, fengchengwen wrote:
> Minor comment on paragraph layout, with that fixed:
> Acked-by: Chengwen Feng <fengchengwen at huawei.com>
>
> On 10/9/2025 9:00 PM, Bruce Richardson wrote:
> > The different value types supported by the argparse library are not
> > discussed in the documentation, so add some reference material about
> > them.
> >
> > Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> > ---
> > doc/guides/prog_guide/argparse_lib.rst | 73 +++++++++++++++++++++++++-
> > 1 file changed, 71 insertions(+), 2 deletions(-)
> >
> > diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide/argparse_lib.rst
> > index b309260d20..7868af5672 100644
> > --- a/doc/guides/prog_guide/argparse_lib.rst
> > +++ b/doc/guides/prog_guide/argparse_lib.rst
> > @@ -160,6 +160,75 @@ both use this way, the parsing is as follows:
> > - For argument ``ooo``, it is positional argument,
> > the ``ooo_val`` will be set to user input's value.
> >
> > +Supported Value Types
> > +~~~~~~~~~~~~~~~~~~~~~
>
> This paragraph should be the inner paragraph of 'Parsing by autosave way'
> I suggest delete the ~~~~~, and move the whole after "Parsing by autosave way"
>
I actually disagree on this. I think the value types needs its own
subsection to hold the various value-type sub-subsections together. I had
originally considered making this a subsection of the autosave one, but
that left us with too many levels of nesting. I think having it at this
level works ok.
More information about the dev
mailing list