From d3e81d86d496fa43a7d634b2b48f329e9ef374dc Mon Sep 17 00:00:00 2001 From: Tian Gao Date: Mon, 20 Nov 2023 17:16:01 -0800 Subject: [PATCH] Update free_tool_id docs for clarification --- 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 f2fe3d76248c2c..762581b7eda7f1 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,