PyTypeObject fields have incorrectly documented types

[JosephWeston]

BPO	24808
Nosy	@bitdancer, @berkerpeksag, @vadmium
Files	PyTypeObject_documentation.patch: Patch to fix the documentation

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/vadmium'
closed_at = <Date 2015-08-25.06:15:42.175>
created_at = <Date 2015-08-06.10:35:58.908>
labels = ['type-feature', 'docs']
title = 'PyTypeObject fields have incorrectly documented types'
updated_at = <Date 2015-08-25.12:59:27.138>
user = 'https://bugs.python.org/JosephWeston'

bugs.python.org fields:

activity = <Date 2015-08-25.12:59:27.138>
actor = 'r.david.murray'
assignee = 'martin.panter'
closed = True
closed_date = <Date 2015-08-25.06:15:42.175>
closer = 'martin.panter'
components = ['Documentation']
creation = <Date 2015-08-06.10:35:58.908>
creator = 'Joseph Weston'
dependencies = []
files = ['40136']
hgrepos = []
issue_num = 24808
keywords = ['patch']
message_count = 5.0
messages = ['248123', '249105', '249107', '249110', '249118']
nosy_count = 6.0
nosy_names = ['r.david.murray', 'docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'Joseph Weston']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue24808'
versions = ['Python 3.4', 'Python 3.5', 'Python 3.6']

[JosephWeston]

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.

[vadmium]

Most of this looks good. For the record, tp_flags was changed to unsigned in 3.4 (bpo-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.)

[python-dev]

New changeset 54a9c649281d by Martin Panter <vadmium> in branch '3.4':
Issue bpo-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 bpo-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 bpo-24808: Merge 3.5 into 3.6
https://hg.python.org/cpython/rev/2637e2593f01

[vadmium]

Okay I think that worked smoothly (let me know if I missed something). Thanks for the patch Joseph.

[bitdancer]

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.