]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-45790: List macros in same order in which fields are described (GH-29529)
authorrtobar <rtobar@icrar.org>
Tue, 5 Apr 2022 02:36:33 +0000 (10:36 +0800)
committerGitHub <noreply@github.com>
Tue, 5 Apr 2022 02:36:33 +0000 (19:36 -0700)
Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Doc/extending/newtypes_tutorial.rst
Misc/NEWS.d/next/Documentation/2021-11-12-11-03-55.bpo-45790.6yuhe8.rst [new file with mode: 0644]

index 530e2c4d35f848ed0f8e1339eeb38e947d42c623..904915306f1f38eefe3f7bfeae6e0d39a70099eb 100644 (file)
@@ -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 (file)
index 0000000..41cf2cb
--- /dev/null
@@ -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.