[3.13] GH-87358: Add clarification about nargs and default argparse behaviour (GH...

GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094)
(cherry picked from commit 20ccda000b5f8365d5f864fd07876804157c2378)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index c4e2dbcac2156c0193a8b702e50752a61979734c..5f7cecd2cad18ea71a53c416ce214c5ed5c04839 100644 (file)
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1122,6 +1122,9 @@ is used when no command-line argument was present::
    >>> parser.parse_args([])
    Namespace(foo=42)
 
+For required_ arguments, the ``default`` value is ignored. For example, this
+applies to positional arguments with nargs_ values other than ``?`` or ``*``,
+or optional arguments marked as ``required=True``.
 
 Providing ``default=argparse.SUPPRESS`` causes no attribute to be added if the
 command-line argument was not present::