[Python-checkins] [3.6] Improve IncrementalEncoder documentation (GH-2746) (GH-3475)
Mariatta
webhook-mailer at python.org
Sun Sep 10 09:26:46 EDT 2017
https://github.com/python/cpython/commit/638601ec52858e19a4e3498c1057a62ee1481e65
commit: 638601ec52858e19a4e3498c1057a62ee1481e65
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017-09-10T06:26:42-07:00
summary:
[3.6] Improve IncrementalEncoder documentation (GH-2746) (GH-3475)
getstate and setstate are instance methods, same as encode and reset.
(cherry picked from commit 30644dee0c14af6c1c61d44166a97cec8245300b)
files:
M Doc/library/codecs.rst
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index 0ecd89ba75b..b9c1868d595 100644
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -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:
More information about the Python-checkins
mailing list