itertools doc: examples for groupby() and tee() #120618
Merged
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
bedevere-app
bot
added
docs
rhettinger
added
skip issue
needs backport to 3.12
|
Thanks @ferdnyc for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 17, 2024
(cherry picked from commit 79e09e6) Co-authored-by: Frank Dana <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 17, 2024
(cherry picked from commit 79e09e6) Co-authored-by: Frank Dana <[email protected]>
|
GH-120637 is a backport of this pull request to the 3.13 branch. |
|
GH-120638 is a backport of this pull request to the 3.12 branch. |
mrahtz
pushed a commit
to mrahtz/cpython
that referenced
this pull request
Jun 30, 2024
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this pull request
Jul 11, 2024
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
|
Thanks @ferdnyc for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Sorry, @ferdnyc and @rhettinger, I could not cleanly backport this to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Since @rhettinger migrated the itertools examples to concise demonstrations in the table(s) of functions (back in 2009, commit 5bfd8ce),
groupby()andtee()have lacked examples of their function.While somewhat less revelatory than the other examples, concise illustrations of their purpose does seem possible. I feel that presenting examples has sufficient merit, particularly for less experienced developers, that it's worth attempting to do so. (Particularly because, in the case of
tee, I don't find the "Results"-column description particularly clear or explanatory.)These are my attempts at demonstrating the two tools via brief code snippets, in a manner similar to how all the other functions are documented. Like the other examples, the details of unpacking the returned iterators are glossed over, showing only the values ultimately produced.
📚 Documentation preview 📚: https://cpython-previews--120618.org.readthedocs.build/