pythonGH-87358: Add clarification about nargs and default argparse be…

…haviour (python#124094)
pablogsal · Sep 24, 2024 · 20ccda0 · 20ccda0
1 parent 38a5beb
commit 20ccda0
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
@@ -1123,6 +1123,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::