Commit 97ea1164 authored by Guido van Rossum's avatar Guido van Rossum

Documented the pop() method for lists.

# The brackets generated by \optional{} are real ugly.  Alas...
parent 9c59ce9b
...@@ -460,17 +460,19 @@ The following operations are defined on mutable sequence types (where ...@@ -460,17 +460,19 @@ The following operations are defined on mutable sequence types (where
\lineiii{\var{s}.append(\var{x})} \lineiii{\var{s}.append(\var{x})}
{same as \code{\var{s}[len(\var{s}):len(\var{s})] = [\var{x}]}}{} {same as \code{\var{s}[len(\var{s}):len(\var{s})] = [\var{x}]}}{}
\lineiii{\var{s}.count(\var{x})} \lineiii{\var{s}.count(\var{x})}
{return number of \var{i}'s for which \code{\var{s}[\var{i}] == \var{x}}}{} {return number of \var{i}'s for which \code{\var{s}[\var{i}] == \var{x}}}{}
\lineiii{\var{s}.index(\var{x})} \lineiii{\var{s}.index(\var{x})}
{return smallest \var{i} such that \code{\var{s}[\var{i}] == \var{x}}}{(1)} {return smallest \var{i} such that \code{\var{s}[\var{i}] == \var{x}}}{(1)}
\lineiii{\var{s}.insert(\var{i}, \var{x})} \lineiii{\var{s}.insert(\var{i}, \var{x})}
{same as \code{\var{s}[\var{i}:\var{i}] = [\var{x}]} {same as \code{\var{s}[\var{i}:\var{i}] = [\var{x}]}
if \code{\var{i} >= 0}}{} if \code{\var{i} >= 0}}{}
\lineiii{\var{s}.pop(\optional{\var{i}})}
{same as \code{x = \var{s}[\var{i}]; del \var{s}[\var{i}]; return x}}{(4)}
\lineiii{\var{s}.remove(\var{x})} \lineiii{\var{s}.remove(\var{x})}
{same as \code{del \var{s}[\var{s}.index(\var{x})]}}{(1)} {same as \code{del \var{s}[\var{s}.index(\var{x})]}}{(1)}
\lineiii{\var{s}.reverse()} \lineiii{\var{s}.reverse()}
{reverses the items of \var{s} in place}{(3)} {reverses the items of \var{s} in place}{(3)}
\lineiii{\var{s}.sort()} \lineiii{\var{s}.sort(\var{cmpfunc})}
{sort the items of \var{s} in place}{(2), (3)} {sort the items of \var{s} in place}{(2), (3)}
\end{tableiii} \end{tableiii}
\indexiv{operations on}{mutable}{sequence}{types} \indexiv{operations on}{mutable}{sequence}{types}
...@@ -508,6 +510,9 @@ list in place for economy of space when sorting or reversing a large ...@@ -508,6 +510,9 @@ 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 list. They don't return the sorted or reversed list to remind you of
this side effect. this side effect.
\item[(4)4] The optional argument \var{i} defaults to \code{-1}, so that
by default the last item is removed and returned.
\end{description} \end{description}
...@@ -849,7 +854,7 @@ object's (writable) attributes; ...@@ -849,7 +854,7 @@ object's (writable) attributes;
\item \item
\code{\var{x}.__methods__} lists the methods of many built-in object types, \code{\var{x}.__methods__} lists the methods of many built-in object types,
e.g., \code{[].__methods__} yields e.g., \code{[].__methods__} yields
\code{['append', 'count', 'index', 'insert', 'remove', 'reverse', 'sort']}; \code{['append', 'count', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']};
\item \item
\code{\var{x}.__members__} lists data attributes; \code{\var{x}.__members__} lists data attributes;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment