diff options
| author | Alex Waygood <Alex.Waygood@Gmail.com> | 2022-10-28 18:17:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-28 18:17:03 +0100 |
| commit | 4320115613c93470dd1e22ec2517f5fc875c5423 (patch) | |
| tree | 1eae3dd57ec8b1cbcfa4e8dac8e592b6778a3f6e | |
| parent | a3b06fd1a2a7089fff00922bff8aee8464219007 (diff) | |
| download | cpython-git-4320115613c93470dd1e22ec2517f5fc875c5423.tar.gz | |
[3.10] `argparse` docs: normalize constant references (#98765) (#98808)
`argparse` docs: normalize constant references (#98765)
(cherry picked from commit b27b57c6e44a276c8a9843fd37d4cf65b2827d5c)
Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
| -rw-r--r-- | Doc/library/argparse.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index d96f17b80a..bdc2ccebb7 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -154,9 +154,10 @@ ArgumentParser objects * usage_ - The string describing the program usage (default: generated from arguments added to parser) - * description_ - Text to display before the argument help (default: none) + * description_ - Text to display before the argument help + (by default, no text) - * epilog_ - Text to display after the argument help (default: none) + * epilog_ - Text to display after the argument help (by default, no text) * parents_ - A list of :class:`ArgumentParser` objects whose arguments should also be included @@ -1831,8 +1832,8 @@ FileType objects Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>) FileType objects understand the pseudo-argument ``'-'`` and automatically - convert this into ``sys.stdin`` for readable :class:`FileType` objects and - ``sys.stdout`` for writable :class:`FileType` objects:: + convert this into :data:`sys.stdin` for readable :class:`FileType` objects and + :data:`sys.stdout` for writable :class:`FileType` objects:: >>> parser = argparse.ArgumentParser() >>> parser.add_argument('infile', type=argparse.FileType('r')) |
