traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs. 

It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().

Patch by Nick Weinhold.
This commit is contained in:
Berker Peksag 2015-07-30 18:26:10 +03:00
parent dcf841b78e
commit 41ca828580
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/codecs.rst
View File

@ -436,8 +436,8 @@ function interfaces of the stateless encoder and decoder:
It defaults to ``'strict'`` handling.
The method may not store state in the :class:`Codec` instance. Use
:class:`StreamCodec` for codecs which have to keep state in order to make
encoding/decoding efficient.
:class:`StreamWriter` for codecs which have to keep state in order to make
encoding efficient.
The encoder must be able to handle zero length input and return an empty object
of the output object type in this situation.
@ -458,8 +458,8 @@ function interfaces of the stateless encoder and decoder:
It defaults to ``'strict'`` handling.
The method may not store state in the :class:`Codec` instance. Use
:class:`StreamCodec` for codecs which have to keep state in order to make
encoding/decoding efficient.
:class:`StreamReader` for codecs which have to keep state in order to make
decoding efficient.
The decoder must be able to handle zero length input and return an empty object
of the output object type in this situation.

8
Lib/codecs.py
View File

@ -141,8 +141,8 @@ class Codec:
'strict' handling.
The method may not store state in the Codec instance. Use
StreamCodec for codecs which have to keep state in order to
make encoding/decoding efficient.
StreamWriter for codecs which have to keep state in order to
make encoding efficient.
The encoder must be able to handle zero length input and
return an empty object of the output object type in this
@ -164,8 +164,8 @@ class Codec:
'strict' handling.
The method may not store state in the Codec instance. Use
StreamCodec for codecs which have to keep state in order to
make encoding/decoding efficient.
StreamReader for codecs which have to keep state in order to
make decoding efficient.
The decoder must be able to handle zero length input and
return an empty object of the output object type in this