From 44d7dce28c7497f7321723444c3058c384cc5f34 Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Wed, 19 Mar 2025 01:34:01 +0900 Subject: [PATCH] gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026) (cherry picked from commit f81990024554a75e2ab31133a72d9f0954690435) Co-authored-by: Yuki Kobayashi --- Doc/c-api/monitoring.rst | 12 ++++++++++++ Doc/library/sys.monitoring.rst | 2 ++ 2 files changed, 14 insertions(+) diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst index 51d866cfd47469..d7b53ab8f23926 100644 --- 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 `. + + .. 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 5f08deba332379..d297bd86d1b7d6 100644 --- 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 ''''''''''''