[3.14] Docs: Improve example for itertools.batched() (GH-136775)
#136778
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 3eecc72)
Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
|
All commit authors signed the Contributor License Agreement. |
AA-Turner
approved these changes
Jul 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current example
batched('ABCDEFG', n=3) → ABC DEF Gcan 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
nargument 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 3eecc72)
Co-authored-by: RafaelWO 38643099+RafaelWO@users.noreply.github.com
📚 Documentation preview 📚: https://cpython-previews--136778.org.readthedocs.build/