From: Berker Peksag <berker.peksag@gmail.com>
Date: Thu, 30 Jul 2015 20:27:13 +0000 (+0300)
Subject: Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode... 
X-Git-Tag: v2.7.11rc1~214
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ffc7e8eebe8cd9f3391ff856be398f8d9ead6587;p=thirdparty%2FPython%2Fcpython.git

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.
---

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index feeb23628999..9529e66d07cb 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 12213e26f361..3d9be35ce5a5 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