diff options
| author | Jade Lovelace <software@lfcode.ca> | 2022-01-02 12:16:25 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-02 12:16:25 -0800 |
| commit | 8e75c6b49b7cb8515b917f01b32ece8c8ea2c0a0 (patch) | |
| tree | af31bd29556b4061127f37613fd7faa98f768617 | |
| parent | ba00f0d93a4aea85ae8089f139856a7c450584d7 (diff) | |
| download | cpython-8e75c6b49b7cb8515b917f01b32ece8c8ea2c0a0.tar.gz cpython-8e75c6b49b7cb8515b917f01b32ece8c8ea2c0a0.zip | |
argparse docs: prog default is the basename of argv[0] (GH-30298)
| -rw-r--r-- | Doc/library/argparse.rst | 3 | ||||
| -rw-r--r-- | Lib/argparse.py | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 80c382a981b..e050d6298b6 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -148,7 +148,8 @@ ArgumentParser objects as keyword arguments. Each parameter has its own more detailed description below, but in short they are: - * prog_ - The name of the program (default: ``sys.argv[0]``) + * prog_ - The name of the program (default: + ``os.path.basename(sys.argv[0])``) * usage_ - The string describing the program usage (default: generated from arguments added to parser) diff --git a/Lib/argparse.py b/Lib/argparse.py index de95eedbee0..1529d9e7687 100644 --- a/Lib/argparse.py +++ b/Lib/argparse.py @@ -1691,7 +1691,8 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer): """Object for parsing command line strings into Python objects. Keyword Arguments: - - prog -- The name of the program (default: sys.argv[0]) + - prog -- The name of the program (default: + ``os.path.basename(sys.argv[0])``) - usage -- A usage message (default: auto-generated from arguments) - description -- A description of what the program does - epilog -- Text following the argument descriptions |