Skip to content

Commit 1a9f51e

Browse files
authored
bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)
1 parent 203b249 commit 1a9f51e

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Doc/library/codecs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ compatible with the Python codec registry.
697697

698698
.. method:: reset()
699699

700-
Flushes and resets the codec buffers used for keeping state.
700+
Resets the codec buffers used for keeping internal state.
701701

702702
Calling this method should ensure that the data on the output is put into
703703
a clean state that allows appending of new fresh data without having to
@@ -792,7 +792,7 @@ compatible with the Python codec registry.
792792

793793
.. method:: reset()
794794

795-
Resets the codec buffers used for keeping state.
795+
Resets the codec buffers used for keeping internal state.
796796

797797
Note that no stream repositioning should take place. This method is
798798
primarily intended to be able to recover from decoding errors.

Lib/codecs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ def writelines(self, list):
386386

387387
def reset(self):
388388

389-
""" Flushes and resets the codec buffers used for keeping state.
389+
""" Resets the codec buffers used for keeping internal state.
390390
391391
Calling this method should ensure that the data on the
392392
output is put into a clean state, that allows appending
@@ -620,7 +620,7 @@ def readlines(self, sizehint=None, keepends=True):
620620

621621
def reset(self):
622622

623-
""" Resets the codec buffers used for keeping state.
623+
""" Resets the codec buffers used for keeping internal state.
624624
625625
Note that no stream repositioning should take place.
626626
This method is primarily intended to be able to recover

0 commit comments

Comments
 (0)