From: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Date: Tue, 18 Mar 2025 16:34:01 +0000 (+0900)
Subject: gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026)
X-Git-Tag: v3.14.0a7~322
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f81990024554a75e2ab31133a72d9f0954690435;p=thirdparty%2FPython%2Fcpython.git

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 bda6cd271197..985a5840af8f 100644
--- 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 cfdcdf2e2df4..918dba9e0281 100644
--- 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
 ''''''''''''