From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 24 Nov 2023 18:15:54 +0000 (+0100)
Subject: [3.12] gh-59254: mention in open() doc that line buffering is for writing (GH-112318... 
X-Git-Tag: v3.12.1~98
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=103728dc151e3797b1b94c635b0bcd9b52c03217;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-59254: mention in open() doc that line buffering is for writing (GH-112318) (#112378)

gh-59254: mention in open() doc that line buffering is for writing (GH-112318)
(cherry picked from commit fafae08cc7caa25f2bd6b29106b50ef76c3e296f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 954c7c0313e6..c86963b4c605 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1221,7 +1221,7 @@ 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
+   buffering (only usable when writing in text mode), and an integer > 1 to indicate the size
    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