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

Update encoding lookup docs wrt #27938 #72579

Closed
scop mannequin opened this issue Oct 9, 2016 · 10 comments
Closed

Update encoding lookup docs wrt #27938 #72579

scop mannequin opened this issue Oct 9, 2016 · 10 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@scop
Copy link
Mannequin

scop mannequin commented Oct 9, 2016

BPO 28393
Nosy @malemburg, @vstinner, @scop, @berkerpeksag
PRs
  • bpo-28393: Update encoding lookup docs wrt bpo-27938 #4871
  • [3.6] bpo-28393: Update encoding lookup docs wrt bpo-27938 (GH-4871) #4881
  • Spelling fixes to docs, docstrings, and comments  #6374
    		•
    Files
  • codecs-doc.patch
  • codecs-doc-2.patch
  • codecs-doc-3.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 2017-12-15.14:23:53.152>
created_at = <Date 2016-10-09.11:39:09.175>
labels = ['type-bug', '3.7', 'docs']
title = 'Update encoding lookup docs wrt python/cpython#72125'
updated_at = <Date 2018-04-04.17:52:44.731>
user = 'https://github.com/scop'

    bugs.python.org fields:

    activity = <Date 2018-04-04.17:52:44.731>
actor = 'scop'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-12-15.14:23:53.152>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2016-10-09.11:39:09.175>
creator = 'scop'
dependencies = []
files = ['45030', '45061', '45085']
hgrepos = []
issue_num = 28393
keywords = ['patch']
message_count = 10.0
messages = ['278354', '278501', '278502', '278526', '278612', '278617', '308337', '308373', '308391', '308393']
nosy_count = 5.0
nosy_names = ['lemburg', 'vstinner', 'scop', 'docs@python', 'berker.peksag']
pr_nums = ['4871', '4881', '6374']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue28393'
versions = ['Python 3.6', 'Python 3.7']
    @scop
    Copy link
    Mannequin Author

    scop mannequin commented Oct 9, 2016

    The attached patch brings codecs docs up to date with respect to changes in bpo-27938.

    @scop scop mannequin added the type-feature A feature request or enhancement label Oct 9, 2016
    @scop scop mannequin assigned docspython Oct 9, 2016
    @scop scop mannequin added the docs Documentation in the Doc dir label Oct 9, 2016
    @berkerpeksag
    Copy link
    Member

    Thanks for the patch! Do we still need to keep the last sentence? Is there any other alternatives that can be used? Perhaps the word "spellings" can be changed with "aliases" to make the sentence a little bit clearer.

    @berkerpeksag berkerpeksag added 3.7 (EOL) end of life type-bug An unexpected behavior, bug, or error and removed type-feature A feature request or enhancement labels Oct 11, 2016
    @scop
    Copy link
    Mannequin Author

    scop mannequin commented Oct 11, 2016

    I believe (but haven't checked) that additionally, encoding names are case insensitive with respect to the fast-path behavior. But then again I also suppose that's the way it was before bpo-27938 as well, which is why I didn't change that in this patch. But why not add it while at it, if I'm correct. Something like this revised patch?

    @malemburg
    Copy link
    Member

    The names are indeed case-insensitive.

    However, something important is missing: the implementation details changed between Python 3.5 and 3.6. Please check the implementation for details and update the documentation with versionadded flags. Thanks.

    @scop
    Copy link
    Mannequin Author

    scop mannequin commented Oct 13, 2016

    codecs-doc-3 contains a versionadded note about us-ascii. I think that's the only end user visible change in the new implementation.

    @malemburg
    Copy link
    Member

    Thanks, Ville.

    @scop
    Copy link
    Mannequin Author

    scop mannequin commented Dec 14, 2017

    I'm getting a 500 internatl server error trying to update https://bugs.python.org/review/28393/, so noting here that the latest review issue has been addressed in #4871

    @vstinner
    Copy link
    Member

    New changeset 297fd87 by Victor Stinner (Ville Skyttä) in branch 'master':
    bpo-28393: Update encoding lookup docs wrt bpo-27938 (bpo-4871)
    297fd87

    @vstinner
    Copy link
    Member

    New changeset 77bf6da by Victor Stinner (Miss Islington (bot)) in branch '3.6':
    bpo-28393: Update encoding lookup docs wrt bpo-27938 (GH-4871) (bpo-4881)
    77bf6da

    @vstinner
    Copy link
    Member

    Thank you Ville Skyttä for your contribution! I merged your PR and backported it to Python 3.6.

    @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.7 (EOL) end of life docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @berkerpeksag @vstinner @malemburg