[issue9014] Incorrect documentation of the PyObject_HEAD macro

Changes by Berker Peksag : -- stage: commit review -> resolved ___ Python tracker ___

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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 rep...@bugs.python.org

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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:

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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

[issue9014] Incorrect documentation of the PyObject_HEAD macro

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

[issue9014] Incorrect documentation of the PyObject_HEAD macro

Ray.Allen ysj@gmail.com added the comment: Additionally, I prefer move the discussion of Py_TRACE_REFS under the documentation of PyObject: http://docs.python.org/dev/py3k/c-api/structures.html?highlight=pyobject_head#PyObject, since they'are connected directly. The doc of PyObject_HEAD

[issue9014] Incorrect documentation of the PyObject_HEAD macro

New submission from Renato Cunha ren...@renatocunha.com: PyObject_HEAD's documentation in py3k (http://docs.python.org/dev/py3k/c-api/structures.html#PyObject_HEAD) uses the same content used in the python 2.x's docs which is wrong, as there were some API changes. PyObject_HEAD is actually