]> granicus.if.org Git - python/commitdiff
#8158: add missing 'description' description to optparse docstring.
authorR David Murray <rdmurray@bitdance.com>
Thu, 5 May 2011 01:05:52 +0000 (21:05 -0400)
committerR David Murray <rdmurray@bitdance.com>
Thu, 5 May 2011 01:05:52 +0000 (21:05 -0400)
Lib/optparse.py

index 87d7737423209215b01867137c9ad680d5dca9cc..731a2bb5edf8541dd1b8a7bc1eae7ae3e7c945eb 100644 (file)
@@ -1131,6 +1131,11 @@ class OptionParser (OptionContainer):
       prog : string
         the name of the current program (to override
         os.path.basename(sys.argv[0])).
+      description : string
+        A paragraph of text giving a brief overview of your program.
+        optparse reformats this paragraph to fit the current terminal
+        width and prints it when the user requests help (after usage,
+        but before the list of options).
       epilog : string
         paragraph of help text to print after option help