[Python-checkins] cpython (merge 3.4 -> 3.5): Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and

[berker.peksag]

https://hg.python.org/cpython/rev/98631f35426f
changeset:   97146:98631f35426f
branch:      3.5
parent:      97143:4476b578b8fd
parent:      97145:f9694502f07c
user:        Berker Peksag <berker.peksag at gmail.com>
date:        Thu Jul 30 18:26:35 2015 +0300
summary:
  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.

files:
  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
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -454,8 +454,8 @@
    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 @@
    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
--- a/Lib/codecs.py
+++ b/Lib/codecs.py
@@ -143,8 +143,8 @@
             '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 @@
             '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

-- 
Repository URL: https://hg.python.org/cpython