From 46500c42f09a8342efde48ad74327d5225158ff3 Mon Sep 17 00:00:00 2001 From: Tian Gao Date: Tue, 21 Nov 2023 14:58:30 -0800 Subject: GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112291) --- Doc/library/sys.monitoring.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/sys.monitoring.rst b/Doc/library/sys.monitoring.rst index f2fe3d7..762581b 100644 --- a/Doc/library/sys.monitoring.rst +++ b/Doc/library/sys.monitoring.rst @@ -54,6 +54,13 @@ Registering and using tools 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 Returns the name of the tool if *tool_id* is in use, -- cgit v0.12