Commit 41ca8285 authored by Berker Peksag's avatar Berker Peksag

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.
parent dcf841b7
......@@ -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.
......
......@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment