Skip to content

[3.12] Fix first parameter name in tool functions from sys.monitoring (GH-111286) #111290

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

Merged
merged 1 commit into from
Oct 24, 2023
Merged

[3.12] Fix first parameter name in tool functions from sys.monitoring (GH-111286) #111290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Doc/library/sys.monitoring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,21 @@ Identifiers are integers in the range 0 to 5 inclusive.
Registering and using tools
'''''''''''''''''''''''''''

.. function:: use_tool_id(id: int, name: str) -> None
.. function:: use_tool_id(tool_id: int, name: str) -> None

Must be called before *id* can be used.
*id* must be in the range 0 to 5 inclusive.
Raises a :exc:`ValueError` if *id* is in use.
Must be called before *tool_id* can be used.
*tool_id* must be in the range 0 to 5 inclusive.
Raises a :exc:`ValueError` if *tool_id* is in use.

.. function:: free_tool_id(id: int) -> None
.. function:: free_tool_id(tool_id: int) -> None

Should be called once a tool no longer requires *id*.
Should be called once a tool no longer requires *tool_id*.

.. function:: get_tool(id: int) -> str | None
.. function:: get_tool(tool_id: int) -> str | None

Returns the name of the tool if *id* is in use,
Returns the name of the tool if *tool_id* is in use,
otherwise it returns ``None``.
*id* must be in the range 0 to 5 inclusive.
*tool_id* must be in the range 0 to 5 inclusive.

All IDs are treated the same by the VM with regard to events, but the
following IDs are pre-defined to make co-operation of tools easier::
Expand Down