https://github.com/python/cpython/commit/f81990024554a75e2ab31133a72d9f0954690435
commit: f81990024554a75e2ab31133a72d9f0954690435
branch: main
author: Yuki Kobayashi <drsuaimqj...@gmail.com>
committer: encukou <encu...@gmail.com>
date: 2025-03-18T17:34:01+01:00
summary:

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

files:
M Doc/c-api/monitoring.rst
M Doc/library/sys.monitoring.rst

diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst
index bda6cd271197d0..985a5840af8fc0 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 cfdcdf2e2df476..918dba9e02810c 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
 ''''''''''''
 

_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com

Reply via email to