From: Ezio Melotti <ezio.melotti@gmail.com>
Date: Sun, 4 Nov 2012 04:59:22 +0000 (+0200)
Subject: #16304: clarify match objects docs.  Initial patch by Jan Duzinkiewicz.
X-Git-Tag: v3.2.4rc1~369
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b87f82f8d46c8cd0fd4ab60f9680ca51ad3345bc;p=thirdparty%2FPython%2Fcpython.git

#16304: clarify match objects docs.  Initial patch by Jan Duzinkiewicz.
---

diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index 8397aad1cf93..26f2a3824ea4 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -814,9 +814,16 @@ attributes:
 Match Objects
 -------------
 
-Match objects always have a boolean value of :const:`True`.  This lets you
-use a simple if-statement to test whether a match was found.  Match objects
-support the following methods and attributes:
+Match objects always have a boolean value of ``True``.
+Since :meth:`~regex.match` and :meth:`~regex.search` return ``None``
+when there is no match, you can test whether there was a match with a simple
+``if`` statement::
+
+   match = re.search(pattern, string)
+   if match:
+       process(match)
+
+Match objects support the following methods and attributes:
 
 
 .. method:: match.expand(template)