summaryrefslogtreecommitdiffstats
path: root/Tools/clinic
diff options
context:
space:
mode:
authorTim Hoffmann <2836374+timhoffm@users.noreply.github.com>2019-06-02 16:58:10 (GMT)
committerPablo Galindo <Pablogsal@gmail.com>2019-06-02 16:58:10 (GMT)
commit5df4025f42b30aca72f441899b361f748c304c57 (patch)
tree20bfa9c0eb9fb31f0116fd798953234d34619aca /Tools/clinic
parent7ffcf848df214135abeea7f6c6faa4135fd0928f (diff)
downloadcpython-5df4025f42b30aca72f441899b361f748c304c57.zip
cpython-5df4025f42b30aca72f441899b361f748c304c57.tar.gz
cpython-5df4025f42b30aca72f441899b361f748c304c57.tar.bz2
Add description to the command line help of the argument clinic (GH-8518)
Diffstat (limited to 'Tools/clinic')
-rwxr-xr-xTools/clinic/clinic.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
index cb2ded4..9880b39 100755
--- a/Tools/clinic/clinic.py
+++ b/Tools/clinic/clinic.py
@@ -4900,7 +4900,14 @@ def main(argv):
sys.exit("Error: clinic.py requires Python 3.3 or greater.")
import argparse
- cmdline = argparse.ArgumentParser()
+ cmdline = argparse.ArgumentParser(
+ description="""Preprocessor for CPython C files.
+
+The purpose of the Argument Clinic is automating all the boilerplate involved
+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')