-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
Fix first parameter name in tool
functions from sys.monitoring
#111286
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
None of these functions doesn't take an keyword arguments, so, I'm doesn't sure that we should change it. If we do decide change that, we should update the description of these functions (because old name of parameter is used there) |
I'm in favor of changing it just because it matches the functions below so it'll probably be easier for users to understand. The signature is another reason - we did use However, as @Eclips4 said, you need to change the function descriptions as well. The descriptions uses id to refer to the argument. The |
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.
Yeah, I'm with @gaogaotiantian here -- apart from anything else, it's pretty confusing when parameter names in the docs don't match the parameter names displayed by help()
in the REPL at runtime. You were absolutely right that other mentions of *id*
also needed to be updated though @Eclips4 -- thanks! I've pushed the necessary changes to @lancelote's branch; will schedule automerge :)
Thanks @lancelote for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
…ythonGH-111286) (cherry picked from commit 8b44f3c) Co-authored-by: Pavel Karateev <[email protected]>
GH-111290 is a backport of this pull request to the 3.12 branch. |
…ing` (GH-111286) (#111290) Fix first parameter name in `tool` functions from `sys.monitoring` (GH-111286) (cherry picked from commit 8b44f3c) Co-authored-by: Pavel Karateev <[email protected]>
Small typo fix, the first parameter of these functions from
sys.monitoring
(Python 3.12) hastool_id
name instead ofid
📚 Documentation preview 📚: https://cpython-previews--111286.org.readthedocs.build/