https://github.com/python/cpython/commit/e69ff34e81eceb69de6623205c87e0145f1831e4
commit: e69ff34e81eceb69de6623205c87e0145f1831e4
branch: main
author: Stanley <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-09-24T10:57:37Z
summary:
gh-65169: Clarify prog default in argparse (GH-31602)
files:
M Doc/library/argparse.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index c4e2dbcac2156c..f22aeb8c13c605 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -249,11 +249,12 @@ The following sections describe how each of these are
used.
prog
^^^^
-By default, :class:`ArgumentParser` objects use ``sys.argv[0]`` to determine
+By default, :class:`ArgumentParser` objects use the base name
+(see :func:`os.path.basename`) of ``sys.argv[0]`` to determine
how to display the name of the program in help messages. This default is
almost
-always desirable because it will make the help messages match how the program
was
-invoked on the command line. For example, consider a file named
-``myprogram.py`` with the following code::
+always desirable because it will make the help messages match the name that was
+used to invoke the program on the command line. For example, consider a file
+named ``myprogram.py`` with the following code::
import argparse
parser = argparse.ArgumentParser()
_______________________________________________
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]
