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

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index a0265135205901b27b4a570bfbb97fa4a4ba3628..3169ae517b75095a4dfbf09572d8dbb285f8635e 100644 (file)
--- 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 3935490d88c8d32ad35656e1efc43c926c105c77..e6ad6e3a0523643fab643798d818e5e4927217d6 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