From 41ca828580aa441baa334625a60f3975d14023eb Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Thu, 30 Jul 2015 18:26:10 +0300 Subject: [PATCH] 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. --- Doc/library/codecs.rst | 8 ++++---- Lib/codecs.py | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 19d71921d22..9496035cd7f 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. diff --git a/Lib/codecs.py b/Lib/codecs.py index 66dd024cd90..4a4d0432720 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -141,8 +141,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 @@ -164,8 +164,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