[3.13] gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026) (GH...

(cherry picked from commit f81990024554a75e2ab31133a72d9f0954690435)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>

diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst
index 51d866cfd47469f3f126afcf8a1b2f99a39e55a9..d7b53ab8f239266e222883091a61d6da3831fddd 100644 (file)
--- a/Doc/c-api/monitoring.rst
+++ b/Doc/c-api/monitoring.rst
@@ -190,3 +190,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 5f08deba33237982f5b612b411f5d6e61cd7e491..d297bd86d1b7d63b1166534102518d0621f7eb37 100644 (file)
--- a/Doc/library/sys.monitoring.rst
+++ b/Doc/library/sys.monitoring.rst
@@ -167,6 +167,8 @@ events, use the expression ``PY_RETURN | PY_START``.
 
 Events are divided into three groups:
 
+.. _monitoring-event-local:
+
 Local events
 ''''''''''''