Skip to content

Commit a4eb2e3

Browse files
[3.12] Fix first parameter name in tool functions from sys.monitoring (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]>
1 parent 2a28aa1 commit a4eb2e3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Doc/library/sys.monitoring.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ Identifiers are integers in the range 0 to 5 inclusive.
4444
Registering and using tools
4545
'''''''''''''''''''''''''''
4646

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

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

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

55-
Should be called once a tool no longer requires *id*.
55+
Should be called once a tool no longer requires *tool_id*.
5656

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

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

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

0 commit comments

Comments
 (0)