Skip to content

gh-126031: Mark argparse parameter headings as code #160632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
techi101 wants to merge 2 commits into
base: main
Choose a base branch
from
+54 −54
Open

gh-126031: Mark argparse parameter headings as code #160632

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
523caa5
gh-126031: Mark argparse constructor parameter headings as code
techi101 Oct 25, 2026
9350a5f
gh-126031: Format add_argument parameter headings as code
techi101 Oct 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 54 additions & 54 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ The following sections describe how each of these are used.

.. _prog:

prog
^^^^
``prog``
^^^^^^^^


By default, :class:`ArgumentParser` calculates the name of the program
Expand Down Expand Up @@ -185,8 +185,8 @@ specifier.
The default ``prog`` value now reflects how ``__main__`` was actually executed,
rather than always being ``os.path.basename(sys.argv[0])``.

usage
^^^^^
``usage``
^^^^^^^^^

By default, :class:`ArgumentParser` calculates the usage message from the
arguments it contains. The default message can be overridden with the
Expand Down Expand Up @@ -217,8 +217,8 @@ usage information across subparsers.

.. _description:

description
^^^^^^^^^^^
``description``
^^^^^^^^^^^^^^^

Most calls to the :class:`ArgumentParser` constructor will use the
``description=`` keyword argument. This argument gives a brief description of
Expand All @@ -230,8 +230,8 @@ By default, the description will be line-wrapped so that it fits within the
given space. To change this behavior, see the formatter_class_ argument.


epilog
^^^^^^
``epilog``
^^^^^^^^^^

Some programs like to display additional description of the program after the
description of the arguments. Such text can be specified using the ``epilog=``
Expand All @@ -255,8 +255,8 @@ line-wrapped, but this behavior can be adjusted with the formatter_class_
argument to :class:`ArgumentParser`.


parents
^^^^^^^
``parents``
^^^^^^^^^^^

Sometimes, several parsers share a common set of arguments. Rather than
repeating the definitions of these arguments, a single parser with all the
Expand Down Expand Up @@ -290,8 +290,8 @@ and one in the child) and raise an error.

.. _formatter_class:

formatter_class
^^^^^^^^^^^^^^^
``formatter_class``
^^^^^^^^^^^^^^^^^^^

:class:`ArgumentParser` objects allow the help formatting to be customized by
specifying an alternate formatting class. Currently, there are four such
Expand Down Expand Up @@ -396,8 +396,8 @@ as the regular formatter does)::
--foo int


prefix_chars
^^^^^^^^^^^^
``prefix_chars``
^^^^^^^^^^^^^^^^

Most command-line options will use ``-`` as the prefix, e.g. ``-f/--foo``.
Parsers that need to support different or additional prefix
Expand All @@ -416,8 +416,8 @@ characters that does not include ``-`` will cause ``-f/--foo`` options to be
disallowed.


fromfile_prefix_chars
^^^^^^^^^^^^^^^^^^^^^
``fromfile_prefix_chars``
^^^^^^^^^^^^^^^^^^^^^^^^^

Sometimes, when dealing with a particularly long argument list, it
may make sense to keep the list of arguments in a file rather than typing it out
Expand Down Expand Up @@ -458,8 +458,8 @@ arguments will never be treated as file references.
Arguments file should be encoded in UTF-8 instead of ANSI Codepage on Windows.


argument_default
^^^^^^^^^^^^^^^^
``argument_default``
^^^^^^^^^^^^^^^^^^^^

Generally, argument defaults are specified either by passing a default to
:meth:`~ArgumentParser.add_argument` or by calling the
Expand All @@ -480,8 +480,8 @@ calls, we supply ``argument_default=SUPPRESS``::

.. _allow_abbrev:

allow_abbrev
^^^^^^^^^^^^
``allow_abbrev``
^^^^^^^^^^^^^^^^

Normally, when you pass an argument list to the
:meth:`~ArgumentParser.parse_args` method of an :class:`ArgumentParser`,
Expand All @@ -499,8 +499,8 @@ This feature can be disabled by setting ``allow_abbrev`` to ``False``::
.. versionadded:: 3.5


conflict_handler
^^^^^^^^^^^^^^^^
``conflict_handler``
^^^^^^^^^^^^^^^^^^^^

:class:`ArgumentParser` objects do not allow two actions with the same option
string. By default, :class:`ArgumentParser` objects raise an exception if an
Expand Down Expand Up @@ -536,8 +536,8 @@ action is retained as the ``-f`` action, because only the ``--foo`` option
string was overridden.


add_help
^^^^^^^^
``add_help``
^^^^^^^^^^^^

By default, :class:`ArgumentParser` objects add an option which simply displays
the parser's help message. If ``-h`` or ``--help`` is supplied at the command
Expand Down Expand Up @@ -569,8 +569,8 @@ the help options::
+h, ++help show this help message and exit


exit_on_error
^^^^^^^^^^^^^
``exit_on_error``
^^^^^^^^^^^^^^^^^

Normally, when you pass an invalid argument list to the :meth:`~ArgumentParser.parse_args`
method of an :class:`ArgumentParser`, it will print a *message* to :data:`sys.stderr` and exit with a status
Expand All @@ -591,8 +591,8 @@ If the user would like to catch errors manually, the feature can be enabled by s

.. versionadded:: 3.9

suggest_on_error
^^^^^^^^^^^^^^^^
``suggest_on_error``
^^^^^^^^^^^^^^^^^^^^

By default, when a user passes an invalid argument choice or subparser name,
:class:`ArgumentParser` will exit with error info and provide suggestions for
Expand All @@ -613,8 +613,8 @@ You can disable suggestions by setting ``suggest_on_error`` to ``False``.
.. versionchanged:: 3.15
Changed default value of ``suggest_on_error`` from ``False`` to ``True``.

color
^^^^^
``color``
^^^^^^^^^

By default, the help message is printed in color using `ANSI escape sequences
<https://en.wikipedia.org/wiki/ANSI_escape_code>`__.
Expand Down Expand Up @@ -701,8 +701,8 @@ The following sections describe how each of these are used.

.. _`name or flags`:

name or flags
^^^^^^^^^^^^^
``name`` or ``flags``
^^^^^^^^^^^^^^^^^^^^^

The :meth:`~ArgumentParser.add_argument` method must know whether an optional
argument, like ``-f`` or ``--foo``, or a positional argument, like a list of
Expand Down Expand Up @@ -755,8 +755,8 @@ the upper-cased name. For example::

.. _action:

action
^^^^^^
``action``
^^^^^^^^^^

:class:`ArgumentParser` objects associate command-line arguments with actions. These
actions can do just about anything with the command-line arguments associated with
Expand Down Expand Up @@ -897,8 +897,8 @@ For more details, see :class:`Action`.

.. _nargs:

nargs
^^^^^
``nargs``
^^^^^^^^^

:class:`ArgumentParser` objects usually associate a single command-line argument with a
single action to be taken. The ``nargs`` keyword argument associates a
Expand Down Expand Up @@ -986,8 +986,8 @@ Actions that do not consume command-line arguments (e.g.

.. _const:

const
^^^^^
``const``
^^^^^^^^^

The ``const`` argument of :meth:`~ArgumentParser.add_argument` is used to hold
constant values that are not read from the command line but are required for
Expand All @@ -1014,8 +1014,8 @@ the various :class:`ArgumentParser` actions. The two most common uses of it are

.. _default:

default
^^^^^^^
``default``
^^^^^^^^^^^

All optional arguments and some positional arguments may be omitted at the
command line. The ``default`` keyword argument of
Expand Down Expand Up @@ -1084,8 +1084,8 @@ command-line argument was not present::

.. _argparse-type:

type
^^^^
``type``
^^^^^^^^

By default, the parser reads command-line arguments in as simple
strings. However, quite often the command-line string should instead be
Expand Down Expand Up @@ -1163,8 +1163,8 @@ using the choices_ keyword instead.

.. _choices:

choices
^^^^^^^
``choices``
^^^^^^^^^^^

Some command-line arguments should be selected from a restricted set of values.
These can be handled by passing a sequence object as the *choices* keyword
Expand Down Expand Up @@ -1204,8 +1204,8 @@ many choices), just specify an explicit metavar_.

.. _required:

required
^^^^^^^^
``required``
^^^^^^^^^^^^

In general, the :mod:`!argparse` module assumes that flags like ``-f`` and ``--bar``
indicate *optional* arguments, which can always be omitted at the command line.
Expand All @@ -1232,8 +1232,8 @@ present at the command line.

.. _help:

help
^^^^
``help``
^^^^^^^^

The ``help`` value is a string containing a brief description of the argument.
When a user requests help (usually by using ``-h`` or ``--help`` at the
Expand Down Expand Up @@ -1274,8 +1274,8 @@ setting the ``help`` value to ``argparse.SUPPRESS``::

.. _metavar:

metavar
^^^^^^^
``metavar``
^^^^^^^^^^^

When :class:`ArgumentParser` generates help messages, it needs some way to refer
to each expected argument. By default, :class:`!ArgumentParser` objects use the dest_
Expand Down Expand Up @@ -1340,8 +1340,8 @@ arguments::

.. _dest:

dest
^^^^
``dest``
^^^^^^^^

Most :class:`ArgumentParser` actions add some value as an attribute of the
object returned by :meth:`~ArgumentParser.parse_args`. The name of this
Expand Down Expand Up @@ -1395,8 +1395,8 @@ strings* rather than ``dest`` names, see conflict_handler_.

.. _deprecated:

deprecated
^^^^^^^^^^
``deprecated``
^^^^^^^^^^^^^^

During a project's lifetime, some arguments may need to be removed from the
command line. Before removing them, you should inform
Expand Down
Loading