Skip to content

Commit df61b78

Browse files
ZeroIntensityencukou
authored andcommitted
gh-141004: Document PY_AUDIT_READ (GH-159720)
(cherry picked from commit 34fe59b) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
1 parent 84990b5 commit df61b78

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
@@ -725,11 +725,20 @@ The following flags can be used with :c:member:`PyMemberDef.flags`:
725725
.. versionchanged:: 3.12
726726
727727
The :c:macro:`!READONLY` macro was renamed to :c:macro:`Py_READONLY`.
728-
The :c:macro:`!PY_AUDIT_READ` macro was renamed with the ``Py_`` prefix.
728+
The :c:macro:`PY_AUDIT_READ` macro was renamed with the ``Py_`` prefix.
729729
The new names are now always available.
730730
Previously, these required ``#include "structmember.h"``.
731731
The header is still available and it provides the old names.
732732
733+
.. c:macro:: PY_AUDIT_READ
734+
735+
Soft-deprecated alias of :c:macro:`Py_AUDIT_READ` (note capitalization of
736+
the ``y``).
737+
Only available with ``#include "structmember.h"``.
738+
739+
.. soft-deprecated:: 3.12
740+
Use :c:macro:`Py_AUDIT_READ` instead.
741+
733742
.. _PyMemberDef-types:
734743
735744
Member types

0 commit comments

Comments
 (0)