-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
gh-125957: sync argument naming in sphinx docs of the cmath and help() #125958
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
Conversation
In the main: $ ./python -m timeit -r11 -s 'from cmath import sin;z=1j' 'sin(z)' 1000000 loops, best of 11: 312 nsec per loop With patch: $ ./python -m timeit -r11 -s 'from cmath import sin;z=1j' 'sin(z)' 1000000 loops, best of 11: 330 nsec per loop
The second commits allows
Alternative solution: include slashed in the sphinx docs to reflect the actual function signature. |
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
I'm going offline until Friday so I won't be able to merge it (@vstinner asked me to wait for one other core dev approval before merging so if someone accepts it, they can either merge it or accept the PR and I'll merge it on Friday) |
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.
I did this once: #101120 This thread discuss an alternative proposal (allow keyword arguments): https://discuss.python.org/t/81003/ See some benchmarks above: #125958 (comment) |
Thanks @skirpichev for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
… help() (pythonGH-125958) (cherry picked from commit 0a3eb88) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
GH-131962 is a backport of this pull request to the 3.13 branch. |
… help() (pythonGH-125958) (cherry picked from commit 0a3eb88) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
GH-131963 is a backport of this pull request to the 3.12 branch. |
…d help() (python#125958) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
📚 Documentation preview 📚: https://cpython-previews--125958.org.readthedocs.build/