From: Raymond Hettinger <python@rcn.com>
Date: Thu, 26 Jun 2003 19:32:10 +0000 (+0000)
Subject: SF patch #760792: "wo" in "word" now valid but not documented as such
X-Git-Tag: v2.3c1~322
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d0cda1dc9fc4c7aa06c4f330d576782ac03b3728;p=python

SF patch #760792: "wo" in "word" now valid but not documented as such
Revised version of a contribution from Gerrit Holl.

Update the docs for the extended behavior of __contains__
---

diff --git a/Doc/ref/ref5.tex b/Doc/ref/ref5.tex
index ae856ffd4e..4949d22d8e 100644
--- a/Doc/ref/ref5.tex
+++ b/Doc/ref/ref5.tex
@@ -913,10 +913,13 @@ only if there exists an index \var{i} such that
 \code{\var{x} == \var{y}[\var{i}]} is true.
 
 For the Unicode and string types, \code{\var{x} in \var{y}} is true if
-and only if there exists an index \var{i} such that \code{\var{x} ==
-\var{y}[\var{i}]} is true. If \code{\var{x}} is not a string or
-Unicode object of length \code{1}, a \exception{TypeError} exception
-is raised.
+and only if \var{x} is a substring of \var{y}.  An equivalent test is
+\code{y.find(x) != -1}.  Note, \var{x} and \var{y} need not be the
+same type; consequently, \code{u'ab' in 'abc'} will return \code{True}.
+Empty strings are always considered to be a substring of any other string,
+so \code{"" in "abc"} will return \code{True}.
+\versionchanged[Previously, \var{x} was required to be a string of
+length \code{1}]{2.3}
 
 For user-defined classes which define the \method{__contains__()} method,
 \code{\var{x} in \var{y}} is true if and only if