Skip to content

gh-135282: correct itertools.accumulate() signature in sphinx docs #135283

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-135282: correct itertools.accumulate() signature in sphinx docs #135283

wants to merge 2 commits into from
+8 −8

Conversation

skirpichev
Copy link
Contributor

@skirpichev skirpichev commented Jun 9, 2025 •
edited
Loading

@skirpichev
pythongh-135282: correct itertools.accumulate() signature in sphinx docs
5f9a94e 
Now it's in sync with docstring/inspect output.
@skirpichev skirpichev requested a review from rhettinger as a code owner June 9, 2025 03:29
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jun 9, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jun 9, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jun 9, 2025
Open
@skirpichev skirpichev added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jun 9, 2025
@skirpichev
Copy link
Contributor Author

@rhettinger, I know you usually against changes in docs, that introduce "advanced" function signatures (despite PDEB decision), but I think this change worth it.

  1. This function has single signature, supported by inspect/help().
  2. Old signature syntax is not explained anywhere in docs.
  3. It also has '*' symbol to guess it's meaning, but in the new version it has tooltip to provide some hints about.

Before:
Screenshot from 2025-06-09 10-47-37
After:
Screenshot from 2025-06-09 10-48-05

BTW, most examples in the module (except for islice/repeat) use AC and could be easily converted to use signatures as in the sphinx docs (i.e., no slashes).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhettinger rhettinger Awaiting requested review from rhettinger rhettinger is a code owner

Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@skirpichev