From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 20 Apr 2022 09:00:32 +0000 (-0700)
Subject: bpo-30718: Add information about text buffering (GH-32351)
X-Git-Tag: v3.9.13~96
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=33c6feb811326e6f6d3487ed88df8dc66c552edc;p=thirdparty%2FPython%2Fcpython.git

bpo-30718: Add information about text buffering (GH-32351)

(cherry picked from commit 5101d97d0b13425ccc5ed37abfabb07701db81fe)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 9a9c707dc177..937e00bf994e 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1113,7 +1113,11 @@ are always available.  They are listed here in alphabetical order.
    *buffering* is an optional integer used to set the buffering policy.  Pass 0
    to switch buffering off (only allowed in binary mode), 1 to select line
    buffering (only usable in text mode), and an integer > 1 to indicate the size
-   in bytes of a fixed-size chunk buffer.  When no *buffering* argument is
+   in bytes of a fixed-size chunk buffer. Note that specifying a buffer size this
+   way applies for binary buffered I/O, but ``TextIOWrapper`` (i.e., files opened
+   with ``mode='r+'``) would have another buffering. To disable buffering in
+   ``TextIOWrapper``, consider using the ``write_through`` flag for
+   :func:`io.TextIOWrapper.reconfigure`. When no *buffering* argument is
    given, the default buffering policy works as follows:
 
    * Binary files are buffered in fixed-size chunks; the size of the buffer is