Improve the descriptions of expected exceptions for __getitem__(),

freddrake · freddrake · commit 91826ed2a9e6 · 2000-07-13T04:57:58.000Z
__setitem__(), and __delitem__().  Based on related comments from
Barry Warsaw.
diff --git a/Doc/ref/ref3.tex b/Doc/ref/ref3.tex
@@ -1091,24 +1091,34 @@ \subsection{Emulating sequence and mapping types\label{sequence-types}}
 
 \begin{methoddesc}[mapping object]{__getitem__}{self, key}
 Called to implement evaluation of \code{\var{self}[\var{key}]}.
-For a sequence types, the accepted keys should be integers.  Note that the
-special interpretation of negative indices (if the class wishes to
+For a sequence types, the accepted keys should be integers.  Note that
+the special interpretation of negative indices (if the class wishes to
 emulate a sequence type) is up to the \method{__getitem__()} method.
+If \var{key} is of an inappropriate type, \exception{TypeError} may be
+raised; if of a value outside the set of indexes for the sequence
+(after any special interpretation of negative values),
+\exception{IndexError} should be raised.
+\strong{Note:}  \keyword{for} loops expect that an
+\exception{IndexError} will be raised for illegal indexes to allow
+proper detection of the end of the sequence.
 \end{methoddesc}
 
 \begin{methoddesc}[mapping object]{__setitem__}{self, key, value}
 Called to implement assignment to \code{\var{self}[\var{key}]}.  Same
 note as for \method{__getitem__()}.  This should only be implemented
 for mappings if the objects support changes to the values for keys, or
 if new keys can be added, or for sequences if elements can be
-replaced.
+replaced.  The same exceptions should be raised for improper
+\var{key} values as for the \method{__getitem__()} method.
 \end{methoddesc}
 
 \begin{methoddesc}[mapping object]{__delitem__}{self, key}
 Called to implement deletion of \code{\var{self}[\var{key}]}.  Same
 note as for \method{__getitem__()}.  This should only be implemented
 for mappings if the objects support removal of keys, or for sequences
-if elements can be removed from the sequence.
+if elements can be removed from the sequence.  The same exceptions
+should be raised for improper \var{key} values as for the
+\method{__getitem__()} method.
 \end{methoddesc}
 
 
