diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 20:27:13 (GMT) |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2015-07-30 20:27:13 (GMT) |
| commit | ffc7e8eebe8cd9f3391ff856be398f8d9ead6587 (patch) | |
| tree | bbdbd1c192895149670cf0d8c93750626c507c9f | |
| parent | 3d731c5994297d2786ccd1a6df1f8dc4cc46cde5 (diff) | |
| download | cpython-ffc7e8eebe8cd9f3391ff856be398f8d9ead6587.zip cpython-ffc7e8eebe8cd9f3391ff856be398f8d9ead6587.tar.gz cpython-ffc7e8eebe8cd9f3391ff856be398f8d9ead6587.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 feeb236..9529e66 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -392,8 +392,8 @@ interfaces of the stateless encoder and decoder: 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. @@ -413,8 +413,8 @@ interfaces of the stateless encoder and decoder: 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 12213e2..3d9be35 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -138,8 +138,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 @@ -161,8 +161,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 |