[3.13] GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (#124440)

miss-islington · savannahostrowski · web-flow · commit b4b182a84d0b · 2024-09-24T11:08:02.000-07:00
GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (cherry picked from commit 20ccda0) Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
diff --git 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::
