[issue9014] Incorrect documentation of the PyObject_HEAD macro
New submission from Renato Cunha
Ray.Allen
Arnon Yaari added the comment:
PEP 3123 is the one that describes this change. I'm submitting a file with the proposed changes to the docs.
----------
keywords: +patch
nosy: +wiggin15
Added file: http://bugs.python.org/file38991/issue9014.diff
_______________________________________
Python tracker
A.M. Kuchling added the comment:
Did you intend to remove the discussion of Py_TRACE_REFS completely? (I've reworked your patch a little bit, adding some markup such as :c:macro:`Py_REFCNT`.)
----------
nosy: +akuchling
Added file: http://bugs.python.org/file39000/issue.txt
_______________________________________
Python tracker
Roundup Robot added the comment:
New changeset 760c5cfacbaa by Gregory P. Smith in branch '3.4':
issue9014: Properly document PyObject_HEAD and friends post-PEP-3123.
https://hg.python.org/cpython/rev/760c5cfacbaa
New changeset 7dc8f0075d60 by Gregory P. Smith in branch 'default':
issue9014: Properly document PyObject_HEAD and friends post-PEP-3123.
https://hg.python.org/cpython/rev/7dc8f0075d60
----------
nosy: +python-dev
_______________________________________
Python tracker
Gregory P. Smith added the comment:
i used wiggin15's patch to start with. I'm now looking at akuchling's patch and will incorporate any additional things it adds (I missed that earlier).
----------
assignee: docs@python -> gregory.p.smith
nosy: +gregory.p.smith
_______________________________________
Python tracker
A.M. Kuchling added the comment:
The markup is not a huge deal, I think. I also did some bits of rewording that can probably be ignored. The TRACE_REFS question is the only important one, I think.
----------
_______________________________________
Python tracker
Roundup Robot added the comment:
New changeset 752ea0acc37e by Gregory P. Smith in branch '3.4':
issue9014: Include more formatting on :c:type:`PyObject` etc.
https://hg.python.org/cpython/rev/752ea0acc37e
New changeset 78a2d1169be1 by Gregory P. Smith in branch 'default':
issue9014: Include more formatting on :c:type:`PyObject` etc.
https://hg.python.org/cpython/rev/78a2d1169be1
----------
_______________________________________
Python tracker
Gregory P. Smith added the comment:
We no longer describe the contents of PyObject in the docs so mentioning Py_TRACE_REFS does not seem worth it as that just changes Py_HEAD_EXTRA which adds the doubly linked list to PyObject (today).
Py_TRACE_REFS isn't useful for anyone to know about IMNSHO as it's a compile time define that normally comes from choosing to do a pydebug build. (I believe we have or have at least had bugs in our code where Py_TRACE_REFS won't work if Py_DEBUG is not also defined as we never test in such a mixed non-DEBUG but with TRACE_REFS configuration)
----------
resolution: -> fixed
stage: -> commit review
status: open -> closed
versions: +Python 3.4, Python 3.5
_______________________________________
Python tracker
Changes by Berker Peksag
participants (7)
-
A.M. Kuchling
-
Arnon Yaari
-
Berker Peksag
-
Gregory P. Smith
-
Ray.Allen
-
Renato Cunha
-
Roundup Robot