[Python-checkins] gh-103921: Rename "type" header in argparse docs (#104654)
JelleZijlstra
webhook-mailer at python.org
Fri May 19 09:50:41 EDT 2023
https://github.com/python/cpython/commit/ab8f54668b0c49186f1da8e127e303ca73220017
commit: ab8f54668b0c49186f1da8e127e303ca73220017
branch: main
author: Jelle Zijlstra <jelle.zijlstra at gmail.com>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2023-05-19T06:50:34-07:00
summary:
gh-103921: Rename "type" header in argparse docs (#104654)
This allows :keyword:`type` to link to docs for the new `type`
statement (being written in gh-104642) instead of to this header
in the argparse docs.
files:
M Doc/library/argparse.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 33e367f3ccda..fbffa71d2007 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -57,20 +57,20 @@ the extracted data in a :class:`argparse.Namespace` object::
Quick Links for add_argument()
------------------------------
-====================== =========================================================== ==========================================================================================================================
-Name Description Values
-====================== =========================================================== ==========================================================================================================================
-action_ Specify how an argument should be handled ``'store'``, ``'store_const'``, ``'store_true'``, ``'append'``, ``'append_const'``, ``'count'``, ``'help'``, ``'version'``
-choices_ Limit values to a specific set of choices ``['foo', 'bar']``, ``range(1, 10)``, or :class:`~collections.abc.Container` instance
-const_ Store a constant value
-default_ Default value used when an argument is not provided Defaults to ``None``
-dest_ Specify the attribute name used in the result namespace
-help_ Help message for an argument
-metavar_ Alternate display name for the argument as shown in help
-nargs_ Number of times the argument can be used :class:`int`, ``'?'``, ``'*'``, or ``'+'``
-required_ Indicate whether an argument is required or optional ``True`` or ``False``
-type_ Automatically convert an argument to the given type :class:`int`, :class:`float`, ``argparse.FileType('w')``, or callable function
-====================== =========================================================== ==========================================================================================================================
+============================ =========================================================== ==========================================================================================================================
+Name Description Values
+============================ =========================================================== ==========================================================================================================================
+action_ Specify how an argument should be handled ``'store'``, ``'store_const'``, ``'store_true'``, ``'append'``, ``'append_const'``, ``'count'``, ``'help'``, ``'version'``
+choices_ Limit values to a specific set of choices ``['foo', 'bar']``, ``range(1, 10)``, or :class:`~collections.abc.Container` instance
+const_ Store a constant value
+default_ Default value used when an argument is not provided Defaults to ``None``
+dest_ Specify the attribute name used in the result namespace
+help_ Help message for an argument
+metavar_ Alternate display name for the argument as shown in help
+nargs_ Number of times the argument can be used :class:`int`, ``'?'``, ``'*'``, or ``'+'``
+required_ Indicate whether an argument is required or optional ``True`` or ``False``
+:ref:`type <argparse-type>` Automatically convert an argument to the given type :class:`int`, :class:`float`, ``argparse.FileType('w')``, or callable function
+============================ =========================================================== ==========================================================================================================================
Example
@@ -1132,7 +1132,7 @@ command-line argument was not present::
Namespace(foo='1')
-.. _type:
+.. _argparse-type:
type
^^^^
More information about the Python-checkins
mailing list