From: Eli Bendersky <eliben@gmail.com>
Date: Sat, 30 Jul 2011 08:14:32 +0000 (+0300)
Subject: Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri... 
X-Git-Tag: v3.2.2rc1~47
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e250358062dda5ff6314e5c03070e47370702d1e;p=python

Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
---

diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst
index 58fb7cd732..fddc1fbe8b 100644
--- a/Doc/library/optparse.rst
+++ b/Doc/library/optparse.rst
@@ -655,8 +655,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: