diff options
author | Berker Peksag <berker.peksag@gmail.com> | 2021-01-06 02:14:42 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-06 02:14:42 (GMT) |
commit | 1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e (patch) | |
tree | 9907b430c331fb46e6be01ca13bda6082ad6d6bf /Doc/library/codecs.rst | |
parent | 203b2493ae6fd7c1f039f3f906f087d67d9100d5 (diff) | |
download | cpython-1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e.zip cpython-1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e.tar.gz cpython-1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e.tar.bz2 |
bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)
Diffstat (limited to 'Doc/library/codecs.rst')
-rw-r--r-- | Doc/library/codecs.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index a026513..3169ae5 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -697,7 +697,7 @@ compatible with the Python codec registry. .. method:: reset() - Flushes and resets the codec buffers used for keeping state. + Resets the codec buffers used for keeping internal state. Calling this method should ensure that the data on the output is put into a clean state that allows appending of new fresh data without having to @@ -792,7 +792,7 @@ compatible with the Python codec registry. .. method:: reset() - Resets the codec buffers used for keeping state. + Resets the codec buffers used for keeping internal state. Note that no stream repositioning should take place. This method is primarily intended to be able to recover from decoding errors. |