summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorPavel Karateev <lancelote.du.lac@gmail.com>2023-10-24 21:19:54 (GMT)
committerGitHub <noreply@github.com>2023-10-24 21:19:54 (GMT)
commit8b44f3c54bb4f99445c108bc0240c458adae9c6f (patch)
tree652dea1cc58664f21e8f442db8a808585779d848 /Doc/library
parentc73b0f35602abf5f283bf64266641f19bc82fce0 (diff)
downloadcpython-8b44f3c54bb4f99445c108bc0240c458adae9c6f.zip
cpython-8b44f3c54bb4f99445c108bc0240c458adae9c6f.tar.gz
cpython-8b44f3c54bb4f99445c108bc0240c458adae9c6f.tar.bz2
Fix first parameter name in `tool` functions from `sys.monitoring` (#111286)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/sys.monitoring.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/library/sys.monitoring.rst b/Doc/library/sys.monitoring.rst
index 1024f66..c2168cd 100644
--- a/Doc/library/sys.monitoring.rst
+++ b/Doc/library/sys.monitoring.rst
@@ -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::