This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: codecs doc: what is StreamCodec?
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: berker.peksag, docs@python, lemburg, martin.panter, ncweinhold, python-dev, sandro.tosi, vstinner
Priority: normal Keywords: patch

Created on 2011-05-23 15:55 by vstinner, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
codecs_incremental.patch vstinner, 2011-05-23 15:55 review
codecs_docs.patch ncweinhold, 2013-03-18 17:35 review
Messages (8)
msg136665 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2011-05-23 15:55
Codec.encode() and Codec.decode() refer to StreamCode, but I cannot find this class in the doc nor in the code.

I suppose that it should be replaced by IncrementalEncoder and IncrementalDecoder. If I'm correct, see attached patch.
msg136675 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2011-05-23 16:23
STINNER Victor wrote:
> 
> New submission from STINNER Victor <victor.stinner@haypocalc.com>:
> 
> Codec.encode() and Codec.decode() refer to StreamCode, but I cannot find this class in the doc nor in the code.
> 
> I suppose that it should be replaced by IncrementalEncoder and IncrementalDecoder. If I'm correct, see attached patch.

Thanks for spotting this.

It should read StreamReader/StreamWriter, since these were designed
to keep state.
msg139150 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-06-26 08:06
Hi Victor, would you update the patch?
msg184476 - (view) Author: Nick Weinhold (ncweinhold) * Date: 2013-03-18 17:35
I've noticed that this issue hasn't been looked at in a while, and from looking through the current docucmentation, it looks like this issue still exists. 

I've uploaded a patch with the changes that Marc-Andre mentioned.
msg233980 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-01-14 00:53
This patch looks simple and uncontroversial. I think it could be merged.
msg247684 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-07-30 15:27
New changeset f9694502f07c by Berker Peksag in branch '3.4':
Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/f9694502f07c

New changeset 98631f35426f by Berker Peksag in branch '3.5':
Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/98631f35426f

New changeset d3b20bff9c5d by Berker Peksag in branch 'default':
Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/d3b20bff9c5d
msg247685 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-07-30 15:28
Thanks for the patch, Nick!
msg247693 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-07-30 20:27
New changeset 296a09614f31 by Berker Peksag in branch '2.7':
Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/296a09614f31
History
Date User Action Args
2022-04-11 14:57:17adminsetgithub: 56369
2015-07-30 20:27:23python-devsetmessages: + msg247693
2015-07-30 15:28:46berker.peksagsetstatus: open -> closed

type: behavior
versions: + Python 3.5, Python 3.6, - Python 3.1, Python 3.2
nosy: + berker.peksag

messages: + msg247685
resolution: fixed
stage: commit review -> resolved
2015-07-30 15:27:39python-devsetnosy: + python-dev
messages: + msg247684
2015-04-09 20:34:20r.david.murraysetstage: patch review -> commit review
2015-01-14 00:53:04martin.pantersetnosy: + martin.panter

messages: + msg233980
versions: + Python 3.4
2013-03-18 17:35:23ncweinholdsetfiles: + codecs_docs.patch
nosy: + ncweinhold
messages: + msg184476

2011-06-26 08:06:28sandro.tosisetnosy: + sandro.tosi
messages: + msg139150
2011-05-24 16:31:01eric.araujosetversions: + Python 3.1, Python 2.7, Python 3.2
nosy: + docs@python

assignee: docs@python
components: + Documentation
stage: patch review
2011-05-23 16:23:54lemburgsetmessages: + msg136675
2011-05-23 15:55:37vstinnercreate