bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)

(cherry picked from commit 1a9f51ed12)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
This commit is contained in:
Miss Islington (bot) 2021-01-05 18:27:30 -08:00 committed by GitHub
parent 77d5471050
commit a3ca6747f5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions

View file

@ -694,7 +694,7 @@ compatible with the Python codec registry.
.. method:: reset() .. 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 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 a clean state that allows appending of new fresh data without having to
@ -789,7 +789,7 @@ compatible with the Python codec registry.
.. method:: reset() .. 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 Note that no stream repositioning should take place. This method is
primarily intended to be able to recover from decoding errors. primarily intended to be able to recover from decoding errors.

View file

@ -386,7 +386,7 @@ def writelines(self, list):
def reset(self): def reset(self):
""" 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 Calling this method should ensure that the data on the
output is put into a clean state, that allows appending output is put into a clean state, that allows appending
@ -620,7 +620,7 @@ def readlines(self, sizehint=None, keepends=True):
def reset(self): def reset(self):
""" 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. Note that no stream repositioning should take place.
This method is primarily intended to be able to recover This method is primarily intended to be able to recover