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.

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

glossary entry for 'method resolution order' links to something with python 2.3 in the title #67863

Closed
bitdancer opened this issue Mar 15, 2015 · 7 comments
Assignees
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@bitdancer
Copy link
Member

BPO 23675
Nosy @orsenthil, @ezio-melotti, @vadmium
Files
  • Issue23675.patch
  • Issue23675-v2.patch
  • 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/orsenthil'
    closed_at = <Date 2016-01-10.06:37:15.204>
    created_at = <Date 2015-03-15.21:50:34.799>
    labels = ['easy', 'type-feature', 'docs']
    title = "glossary entry for 'method resolution order' links to something with python 2.3 in the title"
    updated_at = <Date 2016-01-10.06:37:15.203>
    user = 'https://github.com/bitdancer'

    bugs.python.org fields:

    activity = <Date 2016-01-10.06:37:15.203>
    actor = 'orsenthil'
    assignee = 'orsenthil'
    closed = True
    closed_date = <Date 2016-01-10.06:37:15.204>
    closer = 'orsenthil'
    components = ['Documentation']
    creation = <Date 2015-03-15.21:50:34.799>
    creator = 'r.david.murray'
    dependencies = []
    files = ['41530', '41563']
    hgrepos = []
    issue_num = 23675
    keywords = ['patch', 'easy']
    message_count = 7.0
    messages = ['238161', '257741', '257779', '257890', '257891', '257892', '257893']
    nosy_count = 5.0
    nosy_names = ['orsenthil', 'ezio.melotti', 'docs@python', 'python-dev', 'martin.panter']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'patch review'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue23675'
    versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

    @bitdancer
    Copy link
    Member Author

    The link is correct; that document describes the new-style class method resolution order, which is what Python3 uses. However, the title is a bit problematic, and either the title should be changed or the link from the Python3 docs should have a gloss explaining why the document is in fact the correct link.

    @ezio-melotti ezio-melotti added easy docs Documentation in the Doc dir labels Jan 3, 2016
    @ezio-melotti ezio-melotti added the type-feature A feature request or enhancement label Jan 3, 2016
    @orsenthil
    Copy link
    Member

    Here is the patch with the suggested wording.

    @vadmium
    Copy link
    Member

    vadmium commented Jan 8, 2016

    The wording looks good in spirit. I just have a couple nits to pick with the grammar:

    • Why change from “See” to “Refer”? “Refer to” would work better I think; but “See” was fine too IMO.

    • I think it is better without “document”. Just “See / Refer to <2.3 MRO> for details”.

    • I would insert “the” in “since the 2.3 release”.

    @orsenthil
    Copy link
    Member

    @martin, thanks for the review comments. I've addressed this is version 2 of the patch. I am submitting this change.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jan 10, 2016

    New changeset 9ba001cb107b by Senthil Kumaran in branch '3.5':
    bpo-23675 - A tiny clarification in the MRO glossary term.
    https://hg.python.org/cpython/rev/9ba001cb107b

    New changeset 60d4c3a29201 by Senthil Kumaran in branch 'default':
    merge from 3.5
    https://hg.python.org/cpython/rev/60d4c3a29201

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jan 10, 2016

    New changeset 99f5276e4197 by Senthil Kumaran in branch '2.7':
    bpo-23675 - A tiny clarification in the MRO glossary term.
    https://hg.python.org/cpython/rev/99f5276e4197

    @orsenthil
    Copy link
    Member

    Fixed in the active documentation branches 2.7,3.5 and 3.6.

    @orsenthil orsenthil assigned orsenthil and unassigned docspython Jan 10, 2016
    @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
    Labels
    docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    4 participants