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

Remove missing aliases from codecs documentation #62041

Closed
ncoghlan opened this issue Apr 25, 2013 · 5 comments
Closed

Remove missing aliases from codecs documentation #62041

ncoghlan opened this issue Apr 25, 2013 · 5 comments
Assignees
@ezio-melotti
Labels
docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@ncoghlan
Copy link
Contributor

BPO 17841
Nosy @ncoghlan, @ezio-melotti
Files
  • issue17841_codecs_docu.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/ezio-melotti'
closed_at = <Date 2013-05-10.02:29:06.185>
created_at = <Date 2013-04-25.08:30:29.838>
labels = ['easy', 'type-feature', 'docs']
title = 'Remove missing aliases from codecs documentation'
updated_at = <Date 2013-05-10.06:55:46.372>
user = 'https://github.com/ncoghlan'

    bugs.python.org fields:

    activity = <Date 2013-05-10.06:55:46.372>
actor = 'ncoghlan'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2013-05-10.02:29:06.185>
closer = 'ezio.melotti'
components = ['Documentation']
creation = <Date 2013-04-25.08:30:29.838>
creator = 'ncoghlan'
dependencies = []
files = ['30091']
hgrepos = []
issue_num = 17841
keywords = ['patch', 'easy']
message_count = 5.0
messages = ['187769', '188214', '188802', '188803', '188813']
nosy_count = 5.0
nosy_names = ['ncoghlan', 'ezio.melotti', 'docs@python', 'python-dev', 'Thomas Fenzl']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17841'
versions = ['Python 3.3', 'Python 3.4']
    @ncoghlan
    Copy link
    Contributor Author

    The aliases for the bytes-bytes and str-str codecs are not present in 3.3, so the aliases should be removed from the corresponding standard encoding tables in the documentation.

    http://docs.python.org/3/library/codecs#standard-encodings

    @ncoghlan ncoghlan added the docs Documentation in the Doc dir label Apr 25, 2013
    @ncoghlan ncoghlan added the type-bug An unexpected behavior, bug, or error label Apr 25, 2013
    @ThomasFenzl
    Copy link
    Mannequin

    ThomasFenzl mannequin commented May 1, 2013

    This is a documentation patch against 3.3 with the aliases removed.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented May 10, 2013

    New changeset ead47bc3a763 by Ezio Melotti in branch '3.3':
    bpo-17841: remove missing codecs aliases from the documentation. Patch by Thomas Fenzl.
    http://hg.python.org/cpython/rev/ead47bc3a763

    New changeset eafff38a56cc by Ezio Melotti in branch 'default':
    bpo-17841: merge with 3.3.
    http://hg.python.org/cpython/rev/eafff38a56cc

    @ezio-melotti
    Copy link
    Member

    Fixed, thanks for the patch!

    @nick
    While this works as a short-term solution, I think it would be good to

    1. reintroduce the aliases in 3.4 (so that codecs.encode(b'foo', 'base64') works without spelling out the full codec name);
    2. either separate these codecs from the others, or tweak the error message of str.encode/bytes.decode to point to codecs.encode/decode.
      Should I create a new issue and/or ask python-dev about this?

    @ezio-melotti ezio-melotti added type-feature A feature request or enhancement and removed type-bug An unexpected behavior, bug, or error labels May 10, 2013
    @ncoghlan
    Copy link
    Contributor Author

    For anyone else reading the issue and wondering about Ezio's question above - this issue was actually spun out from bpo-7475, which covers the long saga of getting these codecs fully restored in the new world order of Python 3 :)

    @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

    @ezio-melotti ezio-melotti

    Labels
    docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @ncoghlan @ezio-melotti