diff options
| author | Tian Gao <gaogaotiantian@hotmail.com> | 2023-11-21 22:58:30 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-21 22:58:30 (GMT) |
| commit | 46500c42f09a8342efde48ad74327d5225158ff3 (patch) | |
| tree | 073ac7ab5e44070abd38091b8047bbdd32e705d9 | |
| parent | 9d70831cb7127855a8bf83b585525f13cffb9f59 (diff) | |
| download | cpython-46500c42f09a8342efde48ad74327d5225158ff3.zip cpython-46500c42f09a8342efde48ad74327d5225158ff3.tar.gz cpython-46500c42f09a8342efde48ad74327d5225158ff3.tar.bz2 | |
GH-111963: Clarify sys.monitoring.free_tool_id's limitations (GH-112291)
| -rw-r--r-- | Doc/library/sys.monitoring.rst | 7 |
1 files changed, 7 insertions, 0 deletions
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, |