diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 18:26:35 +0300 |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 18:26:35 +0300 |
commit | 7e94e8ea4bb14e25eecd76c9d34e97cb417f1718 (patch) | |
tree | 632d4246c1b1be9a6ee18363d3d9890276ba2a82 /Doc/library/codecs.rst | |
parent | 4333d8bad72c8fa3ff563284edb090e6541022b0 (diff) | |
parent | 41ca828580aa441baa334625a60f3975d14023eb (diff) | |
download | cpython-git-7e94e8ea4bb14e25eecd76c9d34e97cb417f1718.tar.gz |
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.
Diffstat (limited to 'Doc/library/codecs.rst')
-rw-r--r-- | Doc/library/codecs.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 743ccba58f..dae556e13d 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. |