Issue python#12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.

berkerpeksag · berkerpeksag · commit 7e94e8ea4bb1 · 2015-07-30T18:26:35.000+03:00
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().

Patch by Nick Weinhold.
diff --git 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
@@ -143,8 +143,8 @@ def encode(self, input, errors='strict'):
             '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 @@ def decode(self, input, errors='strict'):
             '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
