Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PyTypeObject fields have incorrectly documented types #68996

Closed
JosephWeston mannequin opened this issue Aug 6, 2015 · 5 comments
Closed

PyTypeObject fields have incorrectly documented types #68996

JosephWeston mannequin opened this issue Aug 6, 2015 · 5 comments
Assignees
@vadmium
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@JosephWeston
Copy link
Mannequin

JosephWeston mannequin commented Aug 6, 2015

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
    Copy link
    Mannequin Author

    JosephWeston mannequin commented Aug 6, 2015

    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.

    @JosephWeston JosephWeston mannequin assigned docspython Aug 6, 2015
    @JosephWeston JosephWeston mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Aug 6, 2015
    @vadmium
    Copy link
    Member

    vadmium commented Aug 25, 2015

    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.)

    @vadmium vadmium assigned vadmium and unassigned docspython Aug 25, 2015
    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Aug 25, 2015

    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
    Copy link
    Member

    vadmium commented Aug 25, 2015

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

    @vadmium vadmium closed this as completed Aug 25, 2015
    @bitdancer
    Copy link
    Member

    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.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @vadmium vadmium

    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @bitdancer @vadmium