]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
In note mentioning [].remove()'s exception, tell what exception is
authorFred Drake <fdrake@acm.org>
Mon, 9 Aug 1999 17:05:12 +0000 (17:05 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 9 Aug 1999 17:05:12 +0000 (17:05 +0000)
raised.  Prompted by Barry's whining.  ;-0

Doc/lib/libstdtypes.tex

index 517cc8814ac9dac3ce049cc1ae77240fd2b8eb9e..39c9290ffe8b9be4227dbfec5cb293e69b060492 100644 (file)
@@ -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}