From: Tian Gao <gaogaotiantian@hotmail.com>
Date: Tue, 21 Nov 2023 22:58:30 +0000 (-0800)
Subject: GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112291)
X-Git-Tag: v3.13.0a2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=46500c42f09a8342efde48ad74327d5225158ff3;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/library/sys.monitoring.rst b/Doc/library/sys.monitoring.rst
index f2fe3d76248c..762581b7eda7 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,