diff options
| author | rtobar <rtobar@icrar.org> | 2022-04-05 02:36:33 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-05 02:36:33 (GMT) |
| commit | b275267aa7d44ec90fa435c9cb1610c549da745a (patch) | |
| tree | b6abcc3a58883a97a9d1a8b12e6cda93b8aa78c7 | |
| parent | 5a4973e29f2f5c4ee8c086f40325786c62381540 (diff) | |
| download | cpython-b275267aa7d44ec90fa435c9cb1610c549da745a.zip cpython-b275267aa7d44ec90fa435c9cb1610c549da745a.tar.gz cpython-b275267aa7d44ec90fa435c9cb1610c549da745a.tar.bz2 | |
bpo-45790: List macros in same order in which fields are described (GH-29529)
Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
| -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 530e2c4..9049153 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 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. |