https://github.com/python/cpython/commit/4e2fb7bdf5e1b2eddeb29b776820cfa2017a673f
commit: 4e2fb7bdf5e1b2eddeb29b776820cfa2017a673f
branch: main
author: Savannah Ostrowski <[email protected]>
committer: rhettinger <[email protected]>
date: 2024-09-25T15:22:17-07:00
summary:
GH-58058: Add quick reference for `ArgumentParser` to argparse docs (gh-124227)
files:
M Doc/library/argparse.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 53ecc97d5659f4..d5a21899ae4f99 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -25,6 +25,25 @@ will figure out how to parse those out of :data:`sys.argv`.
The :mod:`argparse`
module also automatically generates help and usage messages. The module
will also issue errors when users give the program invalid arguments.
+Quick Links for ArgumentParser
+---------------------------------------
+=========================
===========================================================================================================
==================================================================================
+Name Description
Values
+=========================
===========================================================================================================
==================================================================================
+prog_ The name of the program
Defaults to
``os.path.basename(sys.argv[0])``
+usage_ The string describing the program usage
+description_ A brief description of what the program does
+epilog_ Additional description of the program after the
argument help
+parents_ A list of :class:`ArgumentParser` objects whose
arguments should also be included
+formatter_class_ A class for customizing the help output
``argparse.HelpFormatter``
+prefix_chars_ The set of characters that prefix optional arguments
Defaults to ``'-'``
+fromfile_prefix_chars_ The set of characters that prefix files to read
additional arguments from Defaults to
``None`` (meaning arguments will never be treated as file references)
+argument_default_ The global default value for arguments
+allow_abbrev_ Allows long options to be abbreviated if the
abbreviation is unambiguous ``True`` or
``False`` (default: ``True``)
+conflict_handler_ The strategy for resolving conflicting optionals
+add_help_ Add a ``-h/--help`` option to the parser
``True`` or ``False``
(default: ``True``)
+exit_on_error_ Determines whether or not to exit with error info
when an error occurs ``True`` or ``False``
(default: ``True``)
+=========================
===========================================================================================================
==================================================================================
Core Functionality
------------------
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
