From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 19 Mar 2025 10:37:34 +0000 (+0100)
Subject: [3.13] gh-118915: Document `PY_MONITORING_IS_INSTRUMENTED_EVENT` (GH-128026) (GH... 
X-Git-Tag: v3.13.3~104
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=49efc411fa3412f28409b8e5bc0b1e6aaa6b948f;p=thirdparty%2FPython%2Fcpython.git

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

(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 51d866cfd474..d7b53ab8f239 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 <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 5f08deba3323..d297bd86d1b7 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
 ''''''''''''