Moshe Zadka <mzadka@geocities.com>:

Document the __contains__() method.
(Patch slightly modified by FLD.)

This closes SourceForge patch #101387.

diff --git a/Doc/ref/ref3.tex b/Doc/ref/ref3.tex
index 1b072962f9713c78ee92bbb480de590076beb771..53e919fdd90adc4e663a96b949fb7cedd3eb9e48 100644 (file)
--- a/Doc/ref/ref3.tex
+++ b/Doc/ref/ref3.tex
@@ -1172,6 +1172,16 @@ involving extended slice notation, or in absence of the slice methods,
 \method{__getitem__()}, \method{__setitem__()} or \method{__delitem__()} is
 called with a slice object as argument.
 
+The membership test operators (\keyword{in} and \keyword{not in}) are
+normally implemented as iteration loop through the sequence.  However,
+sequence objects can supply the following special method with a more
+efficient implementation:
+
+\begin{methoddesc}[sequence object]{__contains__}{self, item}
+Called to implement membership test operators.  Should return true if
+\var{item} is in \var{self}, false otherwise.
+\end{methoddesc}
+
 
 \subsection{Emulating numeric types\label{numeric-types}}