diff options
author | Jelle Zijlstra <jelle.zijlstra@gmail.com> | 2022-04-05 05:28:21 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-05 05:28:21 (GMT) |
commit | d1fb16ae286795abe3e9da86332c891b4b18826f (patch) | |
tree | 606d465de7ffd518a6ac1dfe1f89ee3bb3c58f1a | |
parent | bc9ec24290d0fa823fa2ac19ac9767b2b8498faa (diff) | |
download | cpython-d1fb16ae286795abe3e9da86332c891b4b18826f.zip cpython-d1fb16ae286795abe3e9da86332c891b4b18826f.tar.gz cpython-d1fb16ae286795abe3e9da86332c891b4b18826f.tar.bz2 |
[3.9] bpo-45790: List macros in same order in which fields are described (GH-29529) (GH-32321)
Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>.
(cherry picked from commit b275267aa7d44ec90fa435c9cb1610c549da745a)
Co-authored-by: rtobar <rtobar@icrar.org>
-rw-r--r-- | Doc/extending/newtypes_tutorial.rst | 4 | ||||
-rw-r--r-- | Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst | 2 |
2 files changed, 4 insertions, 2 deletions
diff --git a/Doc/extending/newtypes_tutorial.rst b/Doc/extending/newtypes_tutorial.rst index 4da77e7..4b5eb69 100644 --- a/Doc/extending/newtypes_tutorial.rst +++ b/Doc/extending/newtypes_tutorial.rst @@ -67,8 +67,8 @@ The first bit is:: This is what a Custom object will contain. ``PyObject_HEAD`` is mandatory at the start of each object struct and defines a field called ``ob_base`` of type :c:type:`PyObject`, containing a pointer to a type object and a -reference count (these can be accessed using the macros :c:macro:`Py_REFCNT` -and :c:macro:`Py_TYPE` respectively). The reason for the macro is to +reference count (these can be accessed using the macros :c:macro:`Py_TYPE` +and :c:macro:`Py_REFCNT` respectively). The reason for the macro is to abstract away the layout and to enable additional fields in debug builds. .. note:: diff --git a/Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst b/Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst new file mode 100644 index 0000000..41cf2cb --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst @@ -0,0 +1,2 @@ +Adjust inaccurate phrasing in :doc:`../extending/newtypes_tutorial` about the +``ob_base`` field and the macros used to access its contents. |