Skip to content

Commit 2bea80e

Browse files
Docs rectifiying
1 parent f8c3bdd commit 2bea80e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

Doc/library/argparse.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1782,7 +1782,7 @@ Sub-commands
17821782
for that particular parser will be printed. The help message will not
17831783
include parent parser or sibling parser messages. (A help message for each
17841784
subparser command, however, can be given by supplying the ``help=`` argument
1785-
to ``add_parser()`` as above.)
1785+
to :meth:`~_SubParsersAction.add_parser` as above.)
17861786

17871787
::
17881788

@@ -1895,7 +1895,9 @@ Sub-commands
18951895
Subparser's *prog* is no longer affected by a custom usage message in
18961896
the main parser.
18971897

1898-
.. method:: _SubParsersAction.add_parser(name, *, help=None, aliases=None, deprecated=False, **kwargs)
1898+
1899+
.. method:: _SubParsersAction.add_parser(name, *, help=None, aliases=None,
1900+
deprecated=False, **kwargs)
18991901
19001902
Creates and returns a new :class:`!ArgumentParser` object for the
19011903
subcommand *name*.
@@ -1904,7 +1906,7 @@ Sub-commands
19041906

19051907
The *help* argument provides a short description for this sub-command.
19061908
If provided, it will be listed next to the command in the main parser’s
1907-
help message (e.g., ``PROG --help``).
1909+
help message (for example, ``PROG --help``).
19081910

19091911
The *aliases* argument allows providing alternative names for this
19101912
sub-command.
@@ -1921,8 +1923,6 @@ Sub-commands
19211923
The *deprecated* argument, if ``True``, marks the sub-command as
19221924
deprecated and will issue a warning when used.
19231925

1924-
.. versionadded:: 3.13
1925-
19261926
For example::
19271927

19281928
>>> parser = argparse.ArgumentParser(prog='chicken.py')
@@ -1932,6 +1932,9 @@ Sub-commands
19321932
chicken.py: warning: command 'fly' is deprecated
19331933
Namespace()
19341934

1935+
.. versionadded:: 3.13
1936+
Added the *deprecated* parameter.
1937+
19351938

19361939
All other keyword arguments are passed directly to the
19371940
:class:`!ArgumentParser` constructor.

0 commit comments

Comments
 (0)