summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-08-09 17:05:12 (GMT)
committerFred Drake <fdrake@acm.org>1999-08-09 17:05:12 (GMT)
commit68921dfa31da43cb468bbb7a99057e11b1859696 (patch)
tree1e972627063b09356d0083056b3acbbdcd9ade14
parent09be4092205e834b6dcfd809b58d09d895de56bc (diff)
downloadcpython-68921dfa31da43cb468bbb7a99057e11b1859696.zip
cpython-68921dfa31da43cb468bbb7a99057e11b1859696.tar.gz
cpython-68921dfa31da43cb468bbb7a99057e11b1859696.tar.bz2
In note mentioning [].remove()'s exception, tell what exception is
raised. Prompted by Barry's whining. ;-0
-rw-r--r--Doc/lib/libstdtypes.tex46
1 files changed, 21 insertions, 25 deletions
diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
index 517cc88..39c9290 100644
--- a/Doc/lib/libstdtypes.tex
+++ b/Doc/lib/libstdtypes.tex
@@ -478,43 +478,39 @@ The following operations are defined on mutable sequence types (where
\indexii{slice}{assignment}
\stindex{del}
\withsubitem{(list method)}{
- \ttindex{append()}
- \ttindex{extend()}
- \ttindex{count()}
- \ttindex{index()}
- \ttindex{insert()}
- \ttindex{pop()}
- \ttindex{remove()}
- \ttindex{reverse()}
+ \ttindex{append()}\ttindex{extend()}\ttindex{count()}\ttindex{index()}
+ \ttindex{insert()}\ttindex{pop()}\ttindex{remove()}\ttindex{reverse()}
\ttindex{sort()}}
\noindent
Notes:
\begin{description}
-\item[(1)] Raises an exception when \var{x} is not found in \var{s}.
-
+\item[(1)] Raises \exception{ValueError} when \var{x} is not found in
+ \var{s}.
+
\item[(2)] The \method{sort()} method takes an optional argument
specifying a comparison function of two arguments (list items) which
- should return \code{-1}, \code{0} or \code{1} depending on whether the
- first argument is considered smaller than, equal to, or larger than the
- second argument. Note that this slows the sorting process down
- considerably; e.g. to sort a list in reverse order it is much faster
- to use calls to the methods \method{sort()} and \method{reverse()}
- than to use the built-in function \function{sort()} with a
- comparison function that reverses the ordering of the elements.
+ should return \code{-1}, \code{0} or \code{1} depending on whether
+ the first argument is considered smaller than, equal to, or larger
+ than the second argument. Note that this slows the sorting process
+ down considerably; e.g. to sort a list in reverse order it is much
+ faster to use calls to the methods \method{sort()} and
+ \method{reverse()} than to use the built-in function
+ \function{sort()} with a comparison function that reverses the
+ ordering of the elements.
\item[(3)] The \method{sort()} and \method{reverse()} methods modify the
-list in place for economy of space when sorting or reversing a large
-list. They don't return the sorted or reversed list to remind you of
-this side effect.
+ list in place for economy of space when sorting or reversing a large
+ list. They don't return the sorted or reversed list to remind you
+ of this side effect.
\item[(4)] The \method{pop()} method is experimental and not supported
-by other mutable sequence types than lists.
-The optional argument \var{i} defaults to \code{-1}, so that
-by default the last item is removed and returned.
+ by other mutable sequence types than lists. The optional argument
+ \var{i} defaults to \code{-1}, so that by default the last item is
+ removed and returned.
\item[(5)] Raises an exception when \var{x} is not a list object. The
-\method{extend()} method is experimental and not supported by mutable types
-other than lists.
+ \method{extend()} method is experimental and not supported by
+ mutable types other than lists.
\end{description}