summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorIrit Katriel <1055913+iritkatriel@users.noreply.github.com>2023-11-24 17:59:41 (GMT)
committerGitHub <noreply@github.com>2023-11-24 17:59:41 (GMT)
commitfafae08cc7caa25f2bd6b29106b50ef76c3e296f (patch)
tree5c6b1a64159759ba60dfe11845a963b552b62ded /Doc/library
parent4ec849bba8286b2ca979f557f633582174a8c4d8 (diff)
downloadcpython-fafae08cc7caa25f2bd6b29106b50ef76c3e296f.zip
cpython-fafae08cc7caa25f2bd6b29106b50ef76c3e296f.tar.gz
cpython-fafae08cc7caa25f2bd6b29106b50ef76c3e296f.tar.bz2
gh-59254: mention in open() doc that line buffering is for writing (#112318)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/functions.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index a72f779..b2dd32f 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