summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2011-07-30 08:12:45 (GMT)
committerEli Bendersky <eliben@gmail.com>2011-07-30 08:12:45 (GMT)
commitdedb502f90f67b86f10ec014c18bc9ace67ee40f (patch)
tree413956fac198e412d404c0086753243d9c427af9 /Doc
parent43162e22c563a1cc0e9d9569b56a2d5e0c1bbbac (diff)
downloadcpython-dedb502f90f67b86f10ec014c18bc9ace67ee40f.zip
cpython-dedb502f90f67b86f10ec014c18bc9ace67ee40f.tar.gz
cpython-dedb502f90f67b86f10ec014c18bc9ace67ee40f.tar.bz2
Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/optparse.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst
index d4b121b..39a44bd 100644
--- a/Doc/library/optparse.rst
+++ b/Doc/library/optparse.rst
@@ -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: