summaryrefslogtreecommitdiffstats
path: root/Tools/clinic
diff options
context:
space:
mode:
authorErlend E. Aasland <erlend@python.org>2023-07-26 22:08:43 (GMT)
committerGitHub <noreply@github.com>2023-07-26 22:08:43 (GMT)
commit2ad699002e3ce09e9fa41e333ac72f16a32d94de (patch)
treee876c8977eca1ea41e2d9719a9e64ea62ba35bd3 /Tools/clinic
parent592395577c679543d899e68a3cff538b8b4df80d (diff)
downloadcpython-2ad699002e3ce09e9fa41e333ac72f16a32d94de.zip
cpython-2ad699002e3ce09e9fa41e333ac72f16a32d94de.tar.gz
cpython-2ad699002e3ce09e9fa41e333ac72f16a32d94de.tar.bz2
Docs: Argument Clinic: Restructure "Basic concepts and usage" (#106981)
Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Diffstat (limited to 'Tools/clinic')
-rwxr-xr-xTools/clinic/clinic.py20
1 files changed, 13 insertions, 7 deletions
diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
index 34cc401..5d3ed41 100755
--- a/Tools/clinic/clinic.py
+++ b/Tools/clinic/clinic.py
@@ -5631,15 +5631,21 @@ with writing argument parsing code for builtins and providing introspection
signatures ("docstrings") for CPython builtins.
For more information see https://docs.python.org/3/howto/clinic.html""")
- cmdline.add_argument("-f", "--force", action='store_true')
- cmdline.add_argument("-o", "--output", type=str)
- cmdline.add_argument("-v", "--verbose", action='store_true')
- cmdline.add_argument("--converters", action='store_true')
+ cmdline.add_argument("-f", "--force", action='store_true',
+ help="force output regeneration")
+ cmdline.add_argument("-o", "--output", type=str,
+ help="redirect file output to OUTPUT")
+ cmdline.add_argument("-v", "--verbose", action='store_true',
+ help="enable verbose mode")
+ cmdline.add_argument("--converters", action='store_true',
+ help=("print a list of all supported converters "
+ "and return converters"))
cmdline.add_argument("--make", action='store_true',
- help="Walk --srcdir to run over all relevant files.")
+ help="walk --srcdir to run over all relevant files")
cmdline.add_argument("--srcdir", type=str, default=os.curdir,
- help="The directory tree to walk in --make mode.")
- cmdline.add_argument("filename", type=str, nargs="*")
+ help="the directory tree to walk in --make mode")
+ cmdline.add_argument("filename", metavar="FILE", type=str, nargs="*",
+ help="the list of files to process")
ns = cmdline.parse_args(argv)
if ns.converters: