Skip to content

Commit 34fe59b

Browse files
gh-141004: Document PY_AUDIT_READ (GH-159720)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
1 parent fa8600c commit 34fe59b

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

‎Doc/c-api/structures.rst‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,11 +760,20 @@ The following flags can be used with :c:member:`PyMemberDef.flags`:
760760
.. versionchanged:: 3.12
761761
762762
The :c:macro:`!READONLY` macro was renamed to :c:macro:`Py_READONLY`.
763-
The :c:macro:`!PY_AUDIT_READ` macro was renamed with the ``Py_`` prefix.
763+
The :c:macro:`PY_AUDIT_READ` macro was renamed with the ``Py_`` prefix.
764764
The new names are now always available.
765765
Previously, these required ``#include "structmember.h"``.
766766
The header is still available and it provides the old names.
767767
768+
.. c:macro:: PY_AUDIT_READ
769+
770+
Soft-deprecated alias of :c:macro:`Py_AUDIT_READ` (note capitalization of
771+
the ``y``).
772+
Only available with ``#include "structmember.h"``.
773+
774+
.. soft-deprecated:: 3.12
775+
Use :c:macro:`Py_AUDIT_READ` instead.
776+
768777
.. _PyMemberDef-types:
769778
770779
Member types

0 commit comments

Comments
 (0)