Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 97ea116

Browse files
committed
Documented the pop() method for lists.
# The brackets generated by \optional{} are real ugly. Alas...
1 parent 9c59ce9 commit 97ea116

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

Doc/lib/libtypes.tex

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -460,17 +460,19 @@ \subsubsection{Mutable Sequence Types}
460460
\lineiii{\var{s}.append(\var{x})}
461461
{same as \code{\var{s}[len(\var{s}):len(\var{s})] = [\var{x}]}}{}
462462
\lineiii{\var{s}.count(\var{x})}
463-
{return number of \var{i}'s for which \code{\var{s}[\var{i}] == \var{x}}}{}
463+
{return number of \var{i}'s for which \code{\var{s}[\var{i}] == \var{x}}}{}
464464
\lineiii{\var{s}.index(\var{x})}
465-
{return smallest \var{i} such that \code{\var{s}[\var{i}] == \var{x}}}{(1)}
465+
{return smallest \var{i} such that \code{\var{s}[\var{i}] == \var{x}}}{(1)}
466466
\lineiii{\var{s}.insert(\var{i}, \var{x})}
467467
{same as \code{\var{s}[\var{i}:\var{i}] = [\var{x}]}
468468
if \code{\var{i} >= 0}}{}
469+
\lineiii{\var{s}.pop(\optional{\var{i}})}
470+
{same as \code{x = \var{s}[\var{i}]; del \var{s}[\var{i}]; return x}}{(4)}
469471
\lineiii{\var{s}.remove(\var{x})}
470472
{same as \code{del \var{s}[\var{s}.index(\var{x})]}}{(1)}
471473
\lineiii{\var{s}.reverse()}
472474
{reverses the items of \var{s} in place}{(3)}
473-
\lineiii{\var{s}.sort()}
475+
\lineiii{\var{s}.sort(\var{cmpfunc})}
474476
{sort the items of \var{s} in place}{(2), (3)}
475477
\end{tableiii}
476478
\indexiv{operations on}{mutable}{sequence}{types}
@@ -508,6 +510,9 @@ \subsubsection{Mutable Sequence Types}
508510
list. They don't return the sorted or reversed list to remind you of
509511
this side effect.
510512

513+
\item[(4)4] The optional argument \var{i} defaults to \code{-1}, so that
514+
by default the last item is removed and returned.
515+
511516
\end{description}
512517

513518

@@ -849,7 +854,7 @@ \subsection{Special Attributes}
849854
\item
850855
\code{\var{x}.__methods__} lists the methods of many built-in object types,
851856
e.g., \code{[].__methods__} yields
852-
\code{['append', 'count', 'index', 'insert', 'remove', 'reverse', 'sort']};
857+
\code{['append', 'count', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']};
853858

854859
\item
855860
\code{\var{x}.__members__} lists data attributes;

0 commit comments

Comments
 (0)