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

urllib.request.Request documentation erroneously refers to the "final two" #81437

Closed
AlanDeSmet mannequin opened this issue Jun 12, 2019 · 7 comments
Closed

urllib.request.Request documentation erroneously refers to the "final two" #81437

AlanDeSmet mannequin opened this issue Jun 12, 2019 · 7 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@AlanDeSmet
Copy link
Mannequin

AlanDeSmet mannequin commented Jun 12, 2019

BPO 37256
Nosy @orsenthil, @Mariatta, @CuriousLearner, @miss-islington
PRs
  • bpo-37256: Wording in Request class docs #14792
  • [3.7] bpo-37256: Wording in Request class docs (GH-14792) #15277
  • [3.8] bpo-37256: Wording in Request class docs (GH-14792) #15278
  • 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 2019-08-16.08:28:18.808>
    created_at = <Date 2019-06-12.19:12:35.941>
    labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
    title = 'urllib.request.Request documentation erroneously refers to the "final two"'
    updated_at = <Date 2019-08-16.08:28:18.807>
    user = 'https://bugs.python.org/AlanDeSmet'

    bugs.python.org fields:

    activity = <Date 2019-08-16.08:28:18.807>
    actor = 'orsenthil'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2019-08-16.08:28:18.808>
    closer = 'orsenthil'
    components = ['Documentation']
    creation = <Date 2019-06-12.19:12:35.941>
    creator = 'Alan De Smet'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 37256
    keywords = ['patch']
    message_count = 7.0
    messages = ['345403', '345404', '349539', '349627', '349699', '349850', '349851']
    nosy_count = 6.0
    nosy_names = ['orsenthil', 'docs@python', 'Mariatta', 'CuriousLearner', 'miss-islington', 'Alan De Smet']
    pr_nums = ['14792', '15277', '15278']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue37256'
    versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

    @AlanDeSmet
    Copy link
    Mannequin Author

    AlanDeSmet mannequin commented Jun 12, 2019

    In Doc/library/urllib.request.rst, in the documentation for the class Request, it says

       The final two arguments are only of interest for correct handling
       of third-party HTTP cookies:
    

    However, three arguments follow, not two, and the last is not necessarily related to third-party cookie handling.

    I believe replacing "final" with "next" will correct the sentence:

       The next two arguments are only of interest for correct handling
       of third-party HTTP cookies:
    

    Verified present in the source releases for CPython 3.5.7, 3.6.8, 3.7.3, 3.8.0b1. It is _not_ present in 2.7.16 (as the third parameter didn't yet exist, so the existing phrasing is correct.)

    @AlanDeSmet AlanDeSmet mannequin added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Jun 12, 2019
    @AlanDeSmet AlanDeSmet mannequin assigned docspython Jun 12, 2019
    @AlanDeSmet AlanDeSmet mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jun 12, 2019
    @AlanDeSmet
    Copy link
    Mannequin Author

    AlanDeSmet mannequin commented Jun 12, 2019

    Oops, used to GitHub/GitLab, where Markdown is fair game. Sorry about that. :-)

    @CuriousLearner
    Copy link
    Member

    Thanks for the bug report Alan & for the PR Ngalim!

    I've checked the current docs and this is a valid bug.

    I've also reviewed the Pull request and it looks good to me.

    @Mariatta, @senthil can you please have a look at this?

    Many thanks!

    @orsenthil
    Copy link
    Member

    New changeset 38c7199 by Senthil Kumaran (Ngalim Siregar) in branch 'master':
    bpo-37256: Wording in Request class docs (bpo-14792)
    38c7199

    @miss-islington
    Copy link
    Contributor

    New changeset 3e1f135 by Miss Islington (bot) in branch '3.7':
    bpo-37256: Wording in Request class docs (GH-14792)
    3e1f135

    @miss-islington
    Copy link
    Contributor

    New changeset f991912 by Miss Islington (bot) in branch '3.8':
    bpo-37256: Wording in Request class docs (GH-14792)
    f991912

    @orsenthil
    Copy link
    Member

    Thank you for the patch, CuriousLearner.

    @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
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants