https://github.com/python/cpython/commit/96fac51a211b0adabc798d0921b53c276b9d83a2
commit: 96fac51a211b0adabc798d0921b53c276b9d83a2
branch: 3.13
author: Miss Islington (bot) <[email protected]>
committer: AA-Turner <[email protected]>
date: 2025-07-19T09:35:48Z
summary:
[3.13] Docs: Improve example for ``itertools.batched()`` (GH-136775) (#136779)
Docs: Improve example for ``itertools.batched()`` (GH-136775)
The current example `batched('ABCDEFG', n=3) → ABC DEF G` can confuse readers
because both, the size of the tuples and the number of tuples are 3.
By using a batch size of n=2, it is clearer that the `n` argument refers to the
size of the resulting tuples.
I.e. the new example is: `batched('ABCDEFG', n=2) → AB CD EF G`
(cherry picked from commit 3eecc72ac70943f7e33297eea17803af15322c88)
Co-authored-by: RafaelWO <[email protected]>
files:
M Doc/library/itertools.rst
diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index 51bbca2cf0f2d4..d07003ac2bb053 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -47,7 +47,7 @@ Iterator Arguments Results
Iterator Arguments Results
Example
============================ ============================
=================================================
=============================================================
:func:`accumulate` p [,func] p0, p0+p1,
p0+p1+p2, ... ``accumulate([1,2,3,4,5]) → 1 3 6 10
15``
-:func:`batched` p, n (p0, p1, ...,
p_n-1), ... ``batched('ABCDEFG', n=3) → ABC DEF G``
+:func:`batched` p, n (p0, p1, ...,
p_n-1), ... ``batched('ABCDEFG', n=2) → AB CD EF G``
:func:`chain` p, q, ... p0, p1, ...
plast, q0, q1, ... ``chain('ABC', 'DEF') → A B C D E F``
:func:`chain.from_iterable` iterable p0, p1, ...
plast, q0, q1, ... ``chain.from_iterable(['ABC', 'DEF']) →
A B C D E F``
:func:`compress` data, selectors (d[0] if
s[0]), (d[1] if s[1]), ... ``compress('ABCDEF', [1,0,1,0,1,1])
→ A C E F``
@@ -181,7 +181,7 @@ loops that truncate the stream.
Roughly equivalent to::
def batched(iterable, n, *, strict=False):
- # batched('ABCDEFG', 3) → ABC DEF G
+ # batched('ABCDEFG', 2) → AB CD EF G
if n < 1:
raise ValueError('n must be at least one')
iterator = iter(iterable)
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
