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

Document codecs decode_encode() and encode_decode() APIs #80711

Closed
gpshead opened this issue Apr 4, 2019 · 1 comment
Closed

Document codecs decode_encode() and encode_decode() APIs #80711

gpshead opened this issue Apr 4, 2019 · 1 comment
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir

Comments

@gpshead
Copy link
Member

gpshead commented Apr 4, 2019

BPO 36530
Nosy @gpshead, @njsmith
Superseder
  • bpo-30588: Missing documentation for codecs.escape_decode
  • 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-04-05.01:02:33.560>
    created_at = <Date 2019-04-04.22:26:09.926>
    labels = ['3.7', '3.8', 'docs']
    title = 'Document codecs decode_encode() and encode_decode() APIs'
    updated_at = <Date 2019-04-05.01:02:33.559>
    user = 'https://github.com/gpshead'

    bugs.python.org fields:

    activity = <Date 2019-04-05.01:02:33.559>
    actor = 'gregory.p.smith'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2019-04-05.01:02:33.560>
    closer = 'gregory.p.smith'
    components = ['Documentation']
    creation = <Date 2019-04-04.22:26:09.926>
    creator = 'gregory.p.smith'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 36530
    keywords = []
    message_count = 1.0
    messages = ['339467']
    nosy_count = 3.0
    nosy_names = ['gregory.p.smith', 'njs', 'docs@python']
    pr_nums = []
    priority = 'normal'
    resolution = 'duplicate'
    stage = 'resolved'
    status = 'closed'
    superseder = '30588'
    type = None
    url = 'https://bugs.python.org/issue36530'
    versions = ['Python 3.7', 'Python 3.8']

    @gpshead
    Copy link
    Member Author

    gpshead commented Apr 4, 2019

    The codecs module has public decode_encode() and encode_decode() functions. They have never been documented, but are recommended for some uses such as:

    https://stackoverflow.com/questions/14820429/how-do-i-decodestring-escape-in-python3/23151714#23151714

    As public APIs, we should document them.

    @gpshead gpshead added 3.7 (EOL) end of life 3.8 only security fixes labels Apr 4, 2019
    @gpshead gpshead added the docs Documentation in the Doc dir label Apr 4, 2019
    @gpshead gpshead closed this as completed Apr 5, 2019
    @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 docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant