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

email.parser.BytesParser.parsebytes docs fix #72080

Closed
scop mannequin opened this issue Aug 30, 2016 · 3 comments
Closed

email.parser.BytesParser.parsebytes docs fix #72080

scop mannequin opened this issue Aug 30, 2016 · 3 comments
Labels
docs Documentation in the Doc dir topic-email type-feature A feature request or enhancement

Comments

@scop
Copy link
Mannequin

scop mannequin commented Aug 30, 2016

BPO 27893
Nosy @warsaw, @scop, @bitdancer, @vadmium
Files
  • parser.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 = None
closed_at = <Date 2016-08-31.01:19:30.530>
created_at = <Date 2016-08-30.14:55:26.404>
labels = ['type-feature', 'expert-email', 'docs']
title = 'email.parser.BytesParser.parsebytes docs fix'
updated_at = <Date 2016-08-31.01:19:30.529>
user = 'https://github.com/scop'

    bugs.python.org fields:

    activity = <Date 2016-08-31.01:19:30.529>
actor = 'r.david.murray'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-08-31.01:19:30.530>
closer = 'r.david.murray'
components = ['Documentation', 'email']
creation = <Date 2016-08-30.14:55:26.404>
creator = 'scop'
dependencies = []
files = ['44270']
hgrepos = []
issue_num = 27893
keywords = ['patch']
message_count = 3.0
messages = ['273975', '273981', '273986']
nosy_count = 6.0
nosy_names = ['barry', 'scop', 'r.david.murray', 'docs@python', 'python-dev', 'martin.panter']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue27893'
versions = ['Python 3.5', 'Python 3.6']
    @scop scop mannequin assigned docspython Aug 30, 2016
    @scop scop mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Aug 30, 2016
    @vadmium
    Copy link
    Member

    vadmium commented Aug 30, 2016

    Actually it seems the parameter is called *text*:

    >>> BytesParser().parsebytes(bytes=b"")
TypeError: parsebytes() got an unexpected keyword argument 'bytes'
>>> BytesParser().parsebytes(text=b"")
<email.message.Message object at 0xb6a2136c>

    @vadmium vadmium changed the title BytesParser.parsebytes docstring fix email.parser.BytesParser.parsebytes docs fix Aug 30, 2016
    @bitdancer
    Copy link
    Member

    Yeah, and it should probably remain so at this point. It's not even completely wrong; from an email perspective it is text. It should also say "equivalent", not "precisely equivalent", since BytesIO is not in fact involved in the implementation.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Aug 31, 2016

    New changeset b8dd9ae08a91 by R David Murray in branch '3.5':
    bpo-27893: arg name and bytes references in email.parser docs.
    https://hg.python.org/cpython/rev/b8dd9ae08a91

    New changeset 059f9f518834 by R David Murray in branch 'default':
    Merge bpo-27893: arg name and bytes references in email.parser docs.
    https://hg.python.org/cpython/rev/059f9f518834

    @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
    docs Documentation in the Doc dir topic-email type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @bitdancer @vadmium