]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Correct info about "f.read(size)". (GH13852)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 10 Sep 2019 16:02:40 +0000 (09:02 -0700)
committerGitHub <noreply@github.com>
Tue, 10 Sep 2019 16:02:40 +0000 (09:02 -0700)
In text mode, the "size" parameter indicates the number of characters, not bytes.
(cherry picked from commit faff81c05f838b0b7a64bbc8c53c02a9b04bb79d)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
Doc/tutorial/inputoutput.rst

index 79427860f518ff842fa4e262f0cc63ba8e8c6be4..1dc01e82102d98545226ed101f5d5c2231d7d5ce 100644 (file)
@@ -356,8 +356,8 @@ To read a file's contents, call ``f.read(size)``, which reads some quantity of
 data and returns it as a string (in text mode) or bytes object (in binary mode).
 *size* is an optional numeric argument.  When *size* is omitted or negative, the
 entire contents of the file will be read and returned; it's your problem if the
-file is twice as large as your machine's memory. Otherwise, at most *size* bytes
-are read and returned.
+file is twice as large as your machine's memory. Otherwise, at most *size*
+characters (in text mode) or *size* bytes (in binary mode) are read and returned.
 If the end of the file has been reached, ``f.read()`` will return an empty
 string (``''``).  ::