GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112291)

This commit is contained in:
Tian Gao 2023-11-21 14:58:30 -08:00 committed by GitHub
parent 9d70831cb7
commit 46500c42f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -54,6 +54,13 @@ Registering and using tools
Should be called once a tool no longer requires *tool_id*. Should be called once a tool no longer requires *tool_id*.
.. note::
:func:`free_tool_id` will not disable global or local events associated
with *tool_id*, nor will it unregister any callback functions. This
function is only intended to be used to notify the VM that the
particular *tool_id* is no longer in use.
.. function:: get_tool(tool_id: int, /) -> str | None .. function:: get_tool(tool_id: int, /) -> str | None
Returns the name of the tool if *tool_id* is in use, Returns the name of the tool if *tool_id* is in use,