From: Guido van Rossum <guido@python.org>
Date: Mon, 21 Sep 1998 19:26:16 +0000 (+0000)
Subject: Explicitly document the fact that the search method returns a MatchObject.
X-Git-Tag: v1.5.2a2~260
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5fb2631ff9ca398aea45e001b1b97e9208ca2e9b;p=python

Explicitly document the fact that the search method returns a MatchObject.
(Reported by Gary Herron.)
---

diff --git a/Doc/lib/libre.tex b/Doc/lib/libre.tex
index c65898ce7d..ca1d88be24 100644
--- a/Doc/lib/libre.tex
+++ b/Doc/lib/libre.tex
@@ -506,7 +506,8 @@ attributes:
 \begin{methoddesc}[RegexObject]{search}{string\optional{, pos}\optional{,
                                         endpos}}
   Scan through \var{string} looking for a location where this regular
-  expression produces a match.  Return \code{None} if no
+  expression produces a match, and return a
+  corresponding \class{MatchObject} instance.  Return \code{None} if no
   position in the string matches the pattern; note that this is
   different from finding a zero-length match at some point in the string.