]> granicus.if.org Git - python/commitdiff
Explicitly document the fact that the search method returns a MatchObject.
authorGuido van Rossum <guido@python.org>
Mon, 21 Sep 1998 19:26:16 +0000 (19:26 +0000)
committerGuido van Rossum <guido@python.org>
Mon, 21 Sep 1998 19:26:16 +0000 (19:26 +0000)
(Reported by Gary Herron.)

Doc/lib/libre.tex

index c65898ce7d8413a16cb3ea7d04bf17f400229b37..ca1d88be24deb0c338c996c66b286faaf0cdfcca 100644 (file)
@@ -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.