]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
clarify the buffer arg
authorBenjamin Peterson <benjamin@python.org>
Tue, 20 Oct 2009 21:56:16 +0000 (21:56 +0000)
committerBenjamin Peterson <benjamin@python.org>
Tue, 20 Oct 2009 21:56:16 +0000 (21:56 +0000)
Doc/library/functions.rst

index 54dd2ea11a83b964f8663531fe32f397d08562bc..3dfbff11a346a7f518127105a013a9e4fe696eb1 100644 (file)
@@ -718,8 +718,8 @@ are always available.  They are listed here in alphabetical order.
 
    *buffering* is an optional integer used to set the buffering policy.  By
    default full buffering is on.  Pass 0 to switch buffering off (only allowed
-   in binary mode), 1 to set line buffering, and an integer > 1 for full
-   buffering.
+   in binary mode), 1 to set line buffering, and an integer > 1 to indicate the
+   size of the buffer.
 
    *encoding* is the name of the encoding used to decode or encode the file.
    This should only be used in text mode.  The default encoding is platform