summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2011-07-30 08:14:32 (GMT)
committerEli Bendersky <eliben@gmail.com>2011-07-30 08:14:32 (GMT)
commite250358062dda5ff6314e5c03070e47370702d1e (patch)
treeac0e09f7071bfd1ceb3ebb454d18c826a2d8171b
parent7bd081c1179e0dd7f7f325ff07a2b50f1f760db0 (diff)
downloadcpython-e250358062dda5ff6314e5c03070e47370702d1e.zip
cpython-e250358062dda5ff6314e5c03070e47370702d1e.tar.gz
cpython-e250358062dda5ff6314e5c03070e47370702d1e.tar.bz2
Issue #11699: fix documentation of OptionParser.get_option_group. Patch by Petri Lehtinen
-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 58fb7cd..fddc1fb 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: