[Python-checkins] Add description to the command line help of the argument clinic (GH-8518)

Pablo Galindo webhook-mailer at python.org
Sun Jun 2 12:58:14 EDT 2019

commit: 5df4025f42b30aca72f441899b361f748c304c57
branch: master
author: Tim Hoffmann <2836374+timhoffm at users.noreply.github.com>
committer: Pablo Galindo <Pablogsal at gmail.com>
date: 2019-06-02T17:58:10+01:00

Add description to the command line help of the argument clinic (GH-8518)

M Tools/clinic/clinic.py

diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
index cb2ded4649dc..9880b3951339 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')

More information about the Python-checkins mailing list