mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 10:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

Improve IncrementalEncoder documentation (GH-2746)

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/codecs.rst
View file

@ -554,16 +554,16 @@ 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).
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`.