]> granicus.if.org Git - python/commitdiff
Improve IncrementalEncoder documentation (GH-2746)
authorZhiming Wang <zmwangx@gmail.com>
Sun, 10 Sep 2017 06:09:55 +0000 (02:09 -0400)
committerMariatta <Mariatta@users.noreply.github.com>
Sun, 10 Sep 2017 06:09:55 +0000 (23:09 -0700)
getstate and setstate are instance methods, same as encode and reset.

Doc/library/codecs.rst

index 0ecd89ba75b617b16b65d672b73c4391c4bc2652..b9c1868d5956d152f63594eeebac6381559af014 100644 (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: