From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 24 Sep 2024 11:19:53 +0000 (+0200)
Subject: [3.12] gh-65169: Clarify prog default in argparse (GH-31602) (GH-124431)
X-Git-Tag: v3.12.7~53
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ed44377220b5b43f5463f420aba982dfe777a3ff;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-65169: Clarify prog default in argparse (GH-31602) (GH-124431)

(cherry picked from commit e69ff34e81eceb69de6623205c87e0145f1831e4)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
---

diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 82f11e1b9aad..4f4a29bfd55c 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()