Skip to content

Commit 298e57a

Browse files
[3.12] GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112304)
(cherry picked from commit 46500c4) Co-authored-by: Tian Gao <[email protected]>
1 parent fab9824 commit 298e57a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Doc/library/sys.monitoring.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ Registering and using tools
5454

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

57+
.. note::
58+
59+
:func:`free_tool_id` will not disable global or local events associated
60+
with *tool_id*, nor will it unregister any callback functions. This
61+
function is only intended to be used to notify the VM that the
62+
particular *tool_id* is no longer in use.
63+
5764
.. function:: get_tool(tool_id: int, /) -> str | None
5865

5966
Returns the name of the tool if *tool_id* is in use,

0 commit comments

Comments
 (0)