summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-09-21 19:26:16 (GMT)
committerGuido van Rossum <guido@python.org>1998-09-21 19:26:16 (GMT)
commit5fb2631ff9ca398aea45e001b1b97e9208ca2e9b (patch)
treecddc9feffa58dfb1aa76a1b6899154f2d22fb236 /Doc/lib
parent4ecd85aad7a3ae1619c76be302540935460b4e12 (diff)
downloadcpython-5fb2631ff9ca398aea45e001b1b97e9208ca2e9b.zip
cpython-5fb2631ff9ca398aea45e001b1b97e9208ca2e9b.tar.gz
cpython-5fb2631ff9ca398aea45e001b1b97e9208ca2e9b.tar.bz2
Explicitly document the fact that the search method returns a MatchObject.
(Reported by Gary Herron.)
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libre.tex3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/lib/libre.tex b/Doc/lib/libre.tex
index c65898c..ca1d88b 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.