mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

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

Browse source 
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:35 +03:00
commit 7e94e8ea4b
2 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/library/codecs.rst
View file

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

8
Lib/codecs.py
View file

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