]> granicus.if.org Git - python/commitdiff
Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri...
authorEli Bendersky <eliben@gmail.com>
Sat, 30 Jul 2011 08:12:45 +0000 (11:12 +0300)
committerEli Bendersky <eliben@gmail.com>
Sat, 30 Jul 2011 08:12:45 +0000 (11:12 +0300)
Doc/library/optparse.rst

index d4b121bc8dc59a6704161b13f0305563ba73abae..39a44bd34b764ff66e74966b1e4e9b06ad115234 100644 (file)
@@ -657,8 +657,9 @@ option groups is:
 
 .. method:: OptionParser.get_option_group(opt_str)
 
-   Return, if defined, the :class:`OptionGroup` that has the title or the long
-   description equals to *opt_str*
+   Return the :class:`OptionGroup` to which the short or long option
+   string *opt_str* (e.g. ``'-o'`` or ``'--option'``) belongs. If
+   there's no such :class:`OptionGroup`, return ``None``.
 
 .. _optparse-printing-version-string: