traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve IncrementalEncoder documentation (GH-2746) 

getstate and setstate are instance methods, same as encode and reset.
This commit is contained in:
Zhiming Wang 2017-09-10 02:09:55 -04:00 committed by Mariatta
parent c0c29dff79
commit 30644dee0c
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/codecs.rst
View File

@ -554,19 +554,19 @@ define in order to be compatible with the Python codec registry.
if necessary, to reset the encoder and to get the output.
.. method:: IncrementalEncoder.getstate()
.. method:: getstate()
Return the current state of the encoder which must be an integer. The
implementation should make sure that ``0`` is the most common state. (States
that are more complicated than integers can be converted into an integer by
marshaling/pickling the state and encoding the bytes of the resulting string
into an integer).
Return the current state of the encoder which must be an integer. The
implementation should make sure that ``0`` is the most common
state. (States that are more complicated than integers can be converted
into an integer by marshaling/pickling the state and encoding the bytes
of the resulting string into an integer).
.. method:: IncrementalEncoder.setstate(state)
.. method:: setstate(state)
Set the state of the encoder to *state*. *state* must be an encoder state
returned by :meth:`getstate`.
Set the state of the encoder to *state*. *state* must be an encoder state
returned by :meth:`getstate`.
.. _incremental-decoder-objects: