From: Georg Brandl <georg@python.org>
Date: Sun, 12 Apr 2009 20:30:53 +0000 (+0000)
Subject: #5719: add short usage example to optparse docstring.
X-Git-Tag: v2.7a1~1488
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=aa48157d3da1ce587f6fb99dced18014b85215dc;p=python

#5719: add short usage example to optparse docstring.
---

diff --git a/Lib/optparse.py b/Lib/optparse.py
index aeb5716a87..8ab329104a 100644
--- a/Lib/optparse.py
+++ b/Lib/optparse.py
@@ -6,6 +6,19 @@ Originally distributed as Optik.
 
 For support, use the optik-users@lists.sourceforge.net mailing list
 (http://lists.sourceforge.net/lists/listinfo/optik-users).
+
+Simple usage example:
+
+   from optparse import OptionParser
+
+   parser = OptionParser()
+   parser.add_option("-f", "--file", dest="filename",
+                     help="write report to FILE", metavar="FILE")
+   parser.add_option("-q", "--quiet",
+                     action="store_false", dest="verbose", default=True,
+                     help="don't print status messages to stdout")
+
+   (options, args) = parser.parse_args()
 """
 
 __version__ = "1.5.3"