diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 15:26:10 (GMT) |
---|---|---|
committer | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 15:26:10 (GMT) |
commit | 41ca828580aa441baa334625a60f3975d14023eb (patch) | |
tree | b93fbd3f97d45b6bb8c8332de5e2d0368aaa7f27 /Doc | |
parent | dcf841b78e7579cdb886cb1a26639b9ee7fbe7b3 (diff) | |
download | cpython-41ca828580aa441baa334625a60f3975d14023eb.zip cpython-41ca828580aa441baa334625a60f3975d14023eb.tar.gz cpython-41ca828580aa441baa334625a60f3975d14023eb.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.
Diffstat (limited to 'Doc')
-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 19d7192..9496035 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -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. |