]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112291)
authorTian Gao <gaogaotiantian@hotmail.com>
Tue, 21 Nov 2023 22:58:30 +0000 (14:58 -0800)
committerGitHub <noreply@github.com>
Tue, 21 Nov 2023 22:58:30 +0000 (14:58 -0800)
Doc/library/sys.monitoring.rst

index f2fe3d76248c2cacf062018f4c6adf0b31b3d520..762581b7eda7f1d7cad5f5bd1bf7a1fc667f4404 100644 (file)
@@ -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,