mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-02 05:12:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source 
Fix first parameter name in `tool` functions from `sys.monitoring` (GH-111286)
(cherry picked from commit 8b44f3c54b)

Co-authored-by: Pavel Karateev <lancelote.du.lac@gmail.com>
This commit is contained in:
Miss Islington (bot) 2023-10-24 23:28:35 +02:00 • committed by GitHub
parent 2a28aa10a8
commit a4eb2e308d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/library/sys.monitoring.rst
View file

@ -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::