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

(cherry picked from commit 1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index f071057293eece49e95ad58ea70a8c45d8d39df2..6eb907afce3c6c30f05f2b7d7113d9b0e82df3cc 100644 (file)
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -694,7 +694,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
@@ -789,7 +789,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 7f23e9775df804e79e4d0869a29dc05e1396a892..d2edd148a290aa487df9719e8725739317f48c1e 100644 (file)
--- 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