[Python-checkins] cpython (3.1): #8158: add missing 'description' description to optparse docstring.

[r.david.murray]

http://hg.python.org/cpython/rev/f559b88bcaa0
changeset:   69839:f559b88bcaa0
branch:      3.1
parent:      69828:7bf9d7ae6c94
user:        R David Murray <rdmurray at bitdance.com>
date:        Wed May 04 21:06:57 2011 -0400
summary:
  #8158: add missing 'description' description to optparse docstring.

files:
  Lib/optparse.py |  5 +++++
  1 files changed, 5 insertions(+), 0 deletions(-)


diff --git a/Lib/optparse.py b/Lib/optparse.py
--- a/Lib/optparse.py
+++ b/Lib/optparse.py
@@ -1120,6 +1120,11 @@
       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
 

-- 
Repository URL: http://hg.python.org/cpython