]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add description to the command line help of the argument clinic (GH-8518)
authorTim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Sun, 2 Jun 2019 16:58:10 +0000 (18:58 +0200)
committerPablo Galindo <Pablogsal@gmail.com>
Sun, 2 Jun 2019 16:58:10 +0000 (17:58 +0100)
Tools/clinic/clinic.py

index cb2ded4649dce28a136c18fb916bd167995dd1fa..9880b395133995be7ebe3ca6e1dd60bbffe457d8 100755 (executable)
@@ -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')