codecs.encode/decode documentation inconsistency

[Ouaouaron]

BPO	21488
Nosy	@brettcannon, @ncoghlan, @vstinner, @berkerpeksag
Files	issue21488.diff codecs_decode_encode_kw.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 2014-05-14.15:11:44.701>
created_at = <Date 2014-05-12.23:37:30.372>
labels = ['type-bug', 'docs']
title = 'codecs.encode/decode documentation inconsistency'
updated_at = <Date 2014-05-14.21:37:35.650>
user = 'https://bugs.python.org/Ouaouaron'

bugs.python.org fields:

activity = <Date 2014-05-14.21:37:35.650>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-05-14.15:11:44.701>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2014-05-12.23:37:30.372>
creator = 'Ouaouaron'
dependencies = []
files = ['35240', '35250']
hgrepos = []
issue_num = 21488
keywords = ['patch']
message_count = 13.0
messages = ['218380', '218464', '218506', '218510', '218511', '218512', '218529', '218539', '218541', '218542', '218543', '218544', '218574']
nosy_count = 7.0
nosy_names = ['brett.cannon', 'ncoghlan', 'vstinner', 'docs@python', 'python-dev', 'berker.peksag', 'Ouaouaron']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue21488'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

[Ouaouaron]

The documentation page for codecs (https://docs.python.org/2/library/codecs.html) shows keyword arguments for codecs.encode and codecs.decode, but they throw an error if keyword arguments are used. codecs.decode.__doc__ reports 'decode(obj, [encoding[,errors]]) -> object.

This happens on both 2.7.6 and 3.4.0.

[brettcannon]

Berker's patch LGTM, so assigning to him to commit.

[ncoghlan]

Brett, if you granted Berker commit privileges, you forgot to update the developer log and issue tracker...

That said, the patch LGTM too.

[vstinner]

For Python 3.5, I would prefer to patch the code to support keywords instead.

[vstinner]

I sent a review on Rietveld.

[vstinner]

codecs_decode_encode_kw.patch: Patch for Python 3.5 adding support of keyword arguments on codecs.encode and codecs.decode.

[brettcannon]

Nope, I forgot Berker had triage rights but not commit rights.

[python-dev]

New changeset cc5e3b93c35a by Victor Stinner in branch '2.7':
Issue bpo-21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
http://hg.python.org/cpython/rev/cc5e3b93c35a

New changeset 2e116176a81f by Victor Stinner in branch '3.4':
Issue bpo-21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
http://hg.python.org/cpython/rev/2e116176a81f

New changeset 889896471498 by Victor Stinner in branch 'default':
Merge 3.4: ignore change specific to 3.4 for bpo-21488, I had a different patch for Python 3.5
http://hg.python.org/cpython/rev/889896471498

[python-dev]

New changeset 6ceedbd88b5f by Victor Stinner in branch '3.4':
Issue bpo-21488: Add support of keyword arguments for codecs.encode and codecs.decode
http://hg.python.org/cpython/rev/6ceedbd88b5f

[vstinner]

I applied all patches and added Brad Aylsworth to Misc/ACKS. Thanks Brad!

Note: I adapted the change for Python 2.7: the default encoding is ASCII, not UTF-8.

[python-dev]

New changeset 0d38044c0b02 by Victor Stinner in branch 'default':
Issue bpo-21488: Add support of keyword arguments for codecs.encode and codecs.decode
http://hg.python.org/cpython/rev/0d38044c0b02

[vstinner]

Ooops, I applied codecs_decode_encode_kw.patch to the branch 3.4 instead of default :-/ I should now be fixed.

[python-dev]

New changeset 0a6f0aaeb96a by Victor Stinner in branch '2.7':
Issue bpo-21488: Oops, the patch for codecs.encode/decode doc was written by
http://hg.python.org/cpython/rev/0a6f0aaeb96a

New changeset 91dca6b9ef0f by Victor Stinner in branch '3.4':
Issue bpo-21488: Oops, the patch for codecs.encode/decode doc was written by
http://hg.python.org/cpython/rev/91dca6b9ef0f