[Python-checkins] bpo-45790: List macros in same order in which fields are described (GH-29529)

miss-islington webhook-mailer at python.org
Mon Apr 4 22:57:27 EDT 2022


https://github.com/python/cpython/commit/f4e711bb49881deb1f07a685878646cd5cdee50f
commit: f4e711bb49881deb1f07a685878646cd5cdee50f
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-04-04T19:57:22-07:00
summary:

bpo-45790: List macros in same order in which fields are described (GH-29529)


Signed-off-by: Rodrigo Tobar <rtobar at icrar.org>

Co-authored-by: Jelle Zijlstra <jelle.zijlstra at gmail.com>
(cherry picked from commit b275267aa7d44ec90fa435c9cb1610c549da745a)

Co-authored-by: rtobar <rtobar at icrar.org>

files:
A Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst
M Doc/extending/newtypes_tutorial.rst

diff --git a/Doc/extending/newtypes_tutorial.rst b/Doc/extending/newtypes_tutorial.rst
index 530e2c4d35f84..904915306f1f3 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 :ref:`debug builds
 <debug-build>`.
 
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 0000000000000..41cf2cb91525f
--- /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.



More information about the Python-checkins mailing list