Issue #17418: specify that buffer sizes are bytes.
authorTerry Jan Reedy <tjreedy@udel.edu>
Sat, 16 Mar 2013 19:55:53 +0000 (15:55 -0400)
committerTerry Jan Reedy <tjreedy@udel.edu>
Sat, 16 Mar 2013 19:55:53 +0000 (15:55 -0400)
Doc/library/functions.rst

index 6d50e0d880a6b9af597123012a41ba544dea94f9..08fb7fedcc59677057dae4c6d6069e606b8e95b9 100644 (file)
@@ -874,9 +874,9 @@ available.  They are listed here in alphabetical order.
 
    The optional *buffering* argument specifies the file's desired buffer size: 0
    means unbuffered, 1 means line buffered, any other positive value means use a
-   buffer of (approximately) that size.  A negative *buffering* means to use the
-   system default, which is usually line buffered for tty devices and fully
-   buffered for other files.  If omitted, the system default is used. [#]_
+   buffer of (approximately) that size (in bytes).  A negative *buffering* means
+   to use the system default, which is usually line buffered for tty devices and
+   fully buffered for other files.  If omitted, the system default is used. [#]_
 
    Modes ``'r+'``, ``'w+'`` and ``'a+'`` open the file for updating (note that
    ``'w+'`` truncates the file).  Append ``'b'`` to the mode to open the file in