summaryrefslogtreecommitdiffstats
path: root/Lib/optparse.py
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-05-05 01:06:57 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-05-05 01:06:57 (GMT)
commitfc5ed800d82a1d2ceaee0121cdffd9d191bfd7ff (patch)
tree58c95c6714a5d1339f38baf1731262e7e57aec80 /Lib/optparse.py
parentf16898bc80fafeaf025606ea00e841c310b8df39 (diff)
downloadcpython-fc5ed800d82a1d2ceaee0121cdffd9d191bfd7ff.zip
cpython-fc5ed800d82a1d2ceaee0121cdffd9d191bfd7ff.tar.gz
cpython-fc5ed800d82a1d2ceaee0121cdffd9d191bfd7ff.tar.bz2
#8158: add missing 'description' description to optparse docstring.
Diffstat (limited to 'Lib/optparse.py')
-rw-r--r--Lib/optparse.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/Lib/optparse.py b/Lib/optparse.py
index 3eb652a..cbd019a 100644
--- a/Lib/optparse.py
+++ b/Lib/optparse.py
@@ -1120,6 +1120,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