Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Itertool docs: Minor clarifications, wording tweaks, spacing, and active voice. #124690

Merged
merged 1 commit into from
Sep 27, 2024

Conversation

rhettinger
Copy link
Contributor

@rhettinger rhettinger commented Sep 27, 2024

  • Improve groupby example to avoid redundant input data which distracts from the grouping by length.
  • Eliminate confusing modifier: module functions -> functions
  • Active voice for the accumulate examples.
  • Higher level use case driven description of chain.
  • Add line spacing to the cycle equivalent code to highlight the two phases.
  • Add line spacing to the filterfalse equivalent code to separate the primary logic from the predicate setup.
  • In the chain description, we had issues with the word iterable which matches the parameter name versus iterator which is the only case where it makes sense to talk about running to exhaustion. Instead, use the high-level word input which is clearer.
  • Add line spacing to the pairwise equivalent code to visually separate the setup code from the main loop logic.

📚 Documentation preview 📚: https://cpython-previews--124690.org.readthedocs.build/

Copy link
Contributor

@DinoV DinoV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rhettinger rhettinger enabled auto-merge (squash) September 27, 2024 18:06
@rhettinger rhettinger merged commit 2e15553 into python:main Sep 27, 2024
30 checks passed
@rhettinger rhettinger deleted the minor_itertool_doc_edits2 branch September 27, 2024 18:50
@rhettinger rhettinger added the needs backport to 3.13 bugs and security fixes label Oct 8, 2024
@miss-islington-app
Copy link

Thanks @rhettinger for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @rhettinger, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 2e155536caf8a090c06d62dd92647abc62362463 3.13

@miss-islington-app miss-islington-app bot assigned rhettinger and unassigned DinoV Oct 8, 2024
rhettinger added a commit to rhettinger/cpython that referenced this pull request Oct 8, 2024
…and active voice. (pythongh-124690)

Minor clarifications, wording tweaks, spacing, and active voice.
@bedevere-app
Copy link

bedevere-app bot commented Oct 8, 2024

GH-125148 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 8, 2024
rhettinger added a commit that referenced this pull request Oct 8, 2024
…and active voice. (gh-124690) (gh-125148)

Minor clarifications, wording tweaks, spacing, and active voice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants