Skip to content

Commit

Permalink
bpo-45790: List macros in same order in which fields are described (G…
Browse files Browse the repository at this point in the history
…H-29529)

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

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
  • Loading branch information
rtobar and JelleZijlstra committed Apr 5, 2022
1 parent 5a4973e commit b275267
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Doc/extending/newtypes_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit b275267

Please sign in to comment.