diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 15:26:35 (GMT) |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 15:26:35 (GMT) |
| commit | 7e94e8ea4bb14e25eecd76c9d34e97cb417f1718 (patch) | |
| tree | 632d4246c1b1be9a6ee18363d3d9890276ba2a82 | |
| parent | 4333d8bad72c8fa3ff563284edb090e6541022b0 (diff) | |
| parent | 41ca828580aa441baa334625a60f3975d14023eb (diff) | |
| download | cpython-7e94e8ea4bb14e25eecd76c9d34e97cb417f1718.zip cpython-7e94e8ea4bb14e25eecd76c9d34e97cb417f1718.tar.gz cpython-7e94e8ea4bb14e25eecd76c9d34e97cb417f1718.tar.bz2 | |
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.
| -rw-r--r-- | Doc/library/codecs.rst | 8 | ||||
| -rw-r--r-- | Lib/codecs.py | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 743ccba..dae556e 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -454,8 +454,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. @@ -476,8 +476,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. diff --git a/Lib/codecs.py b/Lib/codecs.py index 31e73bd..22d5f82 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -143,8 +143,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 @@ -166,8 +166,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 |