classification
Title: PyTypeObject fields have incorrectly documented types
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: martin.panter Nosy List: Joseph Weston, berker.peksag, docs@python, martin.panter, python-dev, r.david.murray
Priority: normal Keywords: patch

Created on 2015-08-06 10:35 by Joseph Weston, last changed 2015-08-25 12:59 by r.david.murray. This issue is now closed.

Files
File name Uploaded Description Edit
PyTypeObject_documentation.patch Joseph Weston, 2015-08-06 10:35 Patch to fix the documentation review
Messages (5)
msg248123 - (view) Author: Joseph Weston (Joseph Weston) * Date: 2015-08-06 10:35
Several fields in the Python 3.x documentation for the PyTypeObject API
have incorrectly documented types. This was probably due to a wholesale
shift of documentation from Python 2.x.
msg249105 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-08-25 04:20
Most of this looks good. For the record, tp_flags was changed to unsigned in 3.4 (Issue 16086). The const and Py_ssize_t changes were done before 3.0.

The only bits I would hesitate about are adding back the two comments saying “Assigned meaning in release 2”. These comments seem to have been removed from the Python 3 documentation in r67578, and I don’t see much point adding them back.

I will have a go at committing the rest of the patch. (This is my first time making a commit.)
msg249107 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-08-25 05:53
New changeset 54a9c649281d by Martin Panter <vadmium> in branch '3.4':
Issue #24808: Update the documentation of some PyTypeObject fields
https://hg.python.org/cpython/rev/54a9c649281d

New changeset e81d692a00b1 by Martin Panter <vadmium> in branch '3.5':
Issue #24808: Merge 3.4 into 3.5; adjust new tp_as_async field
https://hg.python.org/cpython/rev/e81d692a00b1

New changeset 2637e2593f01 by Martin Panter <vadmium> in branch 'default':
Issue #24808: Merge 3.5 into 3.6
https://hg.python.org/cpython/rev/2637e2593f01
msg249110 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-08-25 06:15
Okay I think that worked smoothly (let me know if I missed something). Thanks for the patch Joseph.
msg249118 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2015-08-25 12:59
Congratulation on your first commit, Martin :)

Dropping the python2 reference was the right call: the python3 docs are supposed to be a "fresh start" and there are very few places where they mention python2.
History
Date User Action Args
2015-08-25 12:59:27r.david.murraysetnosy: + r.david.murray
messages: + msg249118
2015-08-25 06:15:42martin.pantersetstatus: open -> closed
resolution: fixed
messages: + msg249110

stage: commit review -> resolved
2015-08-25 05:53:24python-devsetnosy: + python-dev
messages: + msg249107
2015-08-25 04:20:51martin.pantersetversions: - Python 3.2, Python 3.3
nosy: + berker.peksag, martin.panter

messages: + msg249105

assignee: docs@python -> martin.panter
stage: commit review
2015-08-06 10:35:58Joseph Westoncreate