mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 05:35:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.13] gh-65169: Clarify prog default in argparse (GH-31602) (#124430)

Browse source 
gh-65169: Clarify prog default in argparse (GH-31602)
(cherry picked from commit e69ff34e81)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2024-09-24 20:26:32 +02:00 • committed by GitHub
parent 5615351a4b
commit e5105ccbe1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/argparse.rst
View file

@ -249,11 +249,12 @@ The following sections describe how each of these are used.
prog 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 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 always desirable because it will make the help messages match the name that was
invoked on the command line. For example, consider a file named used to invoke the program on the command line. For example, consider a file
``myprogram.py`` with the following code:: named ``myprogram.py`` with the following code::
import argparse import argparse
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()