From 51c374dede0e81ec508c552d21faf019da0b6b20 Mon Sep 17 00:00:00 2001 From: Ezio Melotti Date: Sun, 4 Nov 2012 06:46:28 +0200 Subject: [PATCH] #16304: clarify match objects docs. Initial patch by Jan Duzinkiewicz. --- Doc/library/re.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/Doc/library/re.rst b/Doc/library/re.rst index e6e20d62d2b..1af4cf2011d 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -797,9 +797,16 @@ Match Objects .. class:: MatchObject - Match Objects always have a boolean value of :const:`True`, so that you can test - whether e.g. :func:`match` resulted in a match with a simple if statement. They - 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:: MatchObject.expand(template)