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

Inaccurate phrasing in extending/newtypes_tutorial #89948

Closed
rtobar mannequin opened this issue Nov 12, 2021 · 5 comments
Closed

Inaccurate phrasing in extending/newtypes_tutorial #89948

rtobar mannequin opened this issue Nov 12, 2021 · 5 comments
Labels
3.11 only security fixes docs Documentation in the Doc dir

Comments

@rtobar
Copy link
Mannequin

rtobar mannequin commented Nov 12, 2021

BPO 45790
Nosy @JelleZijlstra, @miss-islington, @rtobar, @rtobar
PRs
  • bpo-45790: List macros in same order in which fields are described #29529
  • [3.10] bpo-45790: List macros in same order in which fields are described (GH-29529) #32320
  • [3.9] bpo-45790: List macros in same order in which fields are described (GH-29529) #32321
    		•

    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 = None
closed_at = <Date 2022-04-05.02:44:46.662>
created_at = <Date 2021-11-12.02:55:53.223>
labels = ['3.11', 'docs']
title = 'Inaccurate phrasing in extending/newtypes_tutorial'
updated_at = <Date 2022-04-05.05:28:25.060>
user = 'https://github.com/rtobar'

    bugs.python.org fields:

    activity = <Date 2022-04-05.05:28:25.060>
actor = 'JelleZijlstra'
assignee = 'docs@python'
closed = True
closed_date = <Date 2022-04-05.02:44:46.662>
closer = 'JelleZijlstra'
components = ['Documentation']
creation = <Date 2021-11-12.02:55:53.223>
creator = 'rtobar2'
dependencies = []
files = []
hgrepos = []
issue_num = 45790
keywords = ['patch']
message_count = 5.0
messages = ['406185', '416722', '416724', '416730', '416752']
nosy_count = 5.0
nosy_names = ['docs@python', 'JelleZijlstra', 'miss-islington', 'rtobar', 'rtobar2']
pr_nums = ['29529', '32320', '32321']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue45790'
versions = ['Python 3.11']
    @rtobar
    Copy link
    Mannequin Author

    rtobar mannequin commented Nov 12, 2021

    In extending/newtypes_tutorial.rst the following phrase appears:

    "[...], containing a pointer to a type object and a reference count (these can be accessed using the macros :c:macro:`Py_REFCNT` and c:macro:`Py_TYPE` respectively)."

    I believe it should read "using the macros :c:macro:`Py_TYPE` and c:macro:`Py_REFCNT` respectively" to follow the same order in which the fields are described.

    I'll put forward a patch. It seems this phrase goes way back a few python versions, but I'm tagging 3.11 here only.

    @rtobar rtobar mannequin added the 3.11 only security fixes label Nov 12, 2021
    @rtobar rtobar mannequin assigned docspython Nov 12, 2021
    @rtobar rtobar mannequin added docs Documentation in the Doc dir 3.11 only security fixes labels Nov 12, 2021
    @rtobar rtobar mannequin assigned docspython Nov 12, 2021
    @rtobar rtobar mannequin added the docs Documentation in the Doc dir label Nov 12, 2021
    @JelleZijlstra
    Copy link
    Member

    New changeset b275267 by rtobar in branch 'main':
    bpo-45790: List macros in same order in which fields are described (GH-29529)
    b275267

    @JelleZijlstra
    Copy link
    Member

    Thanks for noticing and fixing!

    @miss-islington
    Copy link
    Contributor

    New changeset f4e711b by Miss Islington (bot) in branch '3.10':
    bpo-45790: List macros in same order in which fields are described (GH-29529)
    f4e711b

    @JelleZijlstra
    Copy link
    Member

    New changeset d1fb16a by Jelle Zijlstra in branch '3.9':
    [3.9] bpo-45790: List macros in same order in which fields are described (GH-29529) (GH-32321)
    d1fb16a

    @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
    No one assigned
    Labels
    3.11 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @JelleZijlstra @miss-islington