gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026)

diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst
index bda6cd271197d03dc79df24daa1ead1f1fd3e14a..985a5840af8fc08fd0149fe6883d30d69eebeaba 100644 (file)
--- a/Doc/c-api/monitoring.rst
+++ b/Doc/c-api/monitoring.rst
@@ -196,3 +196,15 @@ would typically correspond to a python function.
 .. c:function:: int PyMonitoring_ExitScope(void)
 
    Exit the last scope that was entered with :c:func:`!PyMonitoring_EnterScope`.
+
+
+.. c:function:: int PY_MONITORING_IS_INSTRUMENTED_EVENT(uint8_t ev)
+
+   Return true if the event corresponding to the event ID *ev* is
+   a :ref:`local event <monitoring-event-local>`.
+
+   .. versionadded:: 3.13
+
+   .. deprecated:: next
+
+      This function is :term:`soft deprecated`.

diff --git a/Doc/library/sys.monitoring.rst b/Doc/library/sys.monitoring.rst
index cfdcdf2e2df476048ebec13c0e574d6a21647a7b..918dba9e02810ca93ca42d8f6318630cb09eb2e7 100644 (file)
--- a/Doc/library/sys.monitoring.rst
+++ b/Doc/library/sys.monitoring.rst
@@ -173,6 +173,8 @@ events, use the expression ``PY_RETURN | PY_START``.
 
 Events are divided into three groups:
 
+.. _monitoring-event-local:
+
 Local events
 ''''''''''''