From 1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Wed, 6 Jan 2021 04:14:42 +0200 Subject: bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716) --- Doc/library/codecs.rst | 4 ++-- Lib/codecs.py | 4 ++-- 2 files changed, 4 insertions(+), 4 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. diff --git a/Lib/codecs.py b/Lib/codecs.py index 3935490..e6ad6e3 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -386,7 +386,7 @@ class StreamWriter(Codec): 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 output is put into a clean state, that allows appending @@ -620,7 +620,7 @@ class StreamReader(Codec): 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. This method is primarily intended to be able to recover -- cgit v0.12