summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-10-20 21:56:16 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-10-20 21:56:16 (GMT)
commit810a80ab6451a7173b168c89feb73f04329f2852 (patch)
tree9a38ee2a6f6dab82f4d9ad92c9878c5d61d59d20
parent011bd62c8ca1888e04e579a4dac3dcc103e9a74b (diff)
downloadcpython-810a80ab6451a7173b168c89feb73f04329f2852.zip
cpython-810a80ab6451a7173b168c89feb73f04329f2852.tar.gz
cpython-810a80ab6451a7173b168c89feb73f04329f2852.tar.bz2
clarify the buffer arg
-rw-r--r--Doc/library/functions.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 54dd2ea..3dfbff1 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -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