Commit 1823ae7e authored by Raymond Hettinger's avatar Raymond Hettinger

SF bug #1121416: zip incorrectly and incompletely documented

sequences ==> iterables
parent a30616a8
...@@ -1149,12 +1149,12 @@ It's a function ...@@ -1149,12 +1149,12 @@ It's a function
that the number of elements fit in a native C long.} that the number of elements fit in a native C long.}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{zip}{\optional{seq1, \moreargs}} \begin{funcdesc}{zip}{\optional{iterable, \moreargs}}
This function returns a list of tuples, where the \var{i}-th tuple contains This function returns a list of tuples, where the \var{i}-th tuple contains
the \var{i}-th element from each of the argument sequences. the \var{i}-th element from each of the argument sequences or iterables.
The returned list is truncated in length to the length of The returned list is truncated in length to the length of
the shortest argument sequence. When there are multiple argument the shortest argument sequence. When there are multiple arguments
sequences which are all of the same length, \function{zip()} is which are all of the same length, \function{zip()} is
similar to \function{map()} with an initial argument of \code{None}. similar to \function{map()} with an initial argument of \code{None}.
With a single sequence argument, it returns a list of 1-tuples. With a single sequence argument, it returns a list of 1-tuples.
With no arguments, it returns an empty list. With no arguments, it returns an empty list.
......
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