summaryrefslogtreecommitdiff
path: root/Doc/library/functions.rst
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2015-05-13 02:34:38 -0700
committerRaymond Hettinger <python@rcn.com>2015-05-13 02:34:38 -0700
commit0907a45eb16724e0d4f0e742190dbcf7687b047f (patch)
treeb775de5539c901c10175398b6f47619458202bba /Doc/library/functions.rst
parent2f3742b0d8dbe025f2f9e496938a6d344e6881ad (diff)
downloadcpython-git-0907a45eb16724e0d4f0e742190dbcf7687b047f.tar.gz
Issue #23695: Explain the zip() example for clustering a data series into n-length groups.
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r--Doc/library/functions.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index e982ceb0b9..1321c7a4ca 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1492,7 +1492,9 @@ are always available. They are listed here in alphabetical order.
The left-to-right evaluation order of the iterables is guaranteed. This
makes possible an idiom for clustering a data series into n-length groups
- using ``zip(*[iter(s)]*n)``.
+ using ``zip(*[iter(s)]*n)``. This repeats the *same* iterator ``n`` times
+ so that each output tuple has the result of ``n`` calls to the iterator.
+ This has the effect of dividing the input into n-length chunks.
:func:`zip` should only be used with unequal length inputs when you don't
care about trailing, unmatched values from the longer iterables. If those