Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.4k
Docs: Improve example foritertools.batched()#136775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
AA-Turner merged 1 commit intopython:mainfromRafaelWO:change/improve-itertools.batched-docs-exampleJul 19, 2025
Merged
Docs: Improve example foritertools.batched()#136775
AA-Turner merged 1 commit intopython:mainfromRafaelWO:change/improve-itertools.batched-docs-exampleJul 19, 2025
+2 −2
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`python-cla-botbot commentedJul 19, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
All commit authors signed the Contributor License Agreement. |
@AA-Turner, thanks for the review! 🙂 |
AA-Turner approved these changesJul 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thank you!
A
itertools.batcheditertools.batched()3eecc72 intopython:main 43 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Thanks@RafaelWO for the PR, and@AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestJul 19, 2025
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 <38643099+RafaelWO@users.noreply.github.com>miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestJul 19, 2025
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 commit3eecc72)Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>GH-136778 is a backport of this pull request to the3.14 branch. |
GH-136779 is a backport of this pull request to the3.13 branch. |
AA-Turner pushed a commit that referenced this pull requestJul 19, 2025
…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 commit3eecc72)Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
AA-Turner pushed a commit that referenced this pull requestJul 19, 2025
…136778)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 commit3eecc72)Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
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 thenargument refers to the size of the resulting tuples. I.e. the new example is:batched('ABCDEFG', n=2) → AB CD EF G📚 Documentation preview 📚:https://cpython-previews--136775.org.readthedocs.build/