summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-06-14 14:37:23 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-06-14 14:37:23 (GMT)
commit2a8b54d29cc943e7b8bc493d5500463b0e0af5ff (patch)
treeb49af5848a8866ab96ebb2eb7a7b66912b754bf9
parent3d8827dab67799ab624c22fa27fa423cb14ace27 (diff)
downloadcpython-2a8b54d29cc943e7b8bc493d5500463b0e0af5ff.zip
cpython-2a8b54d29cc943e7b8bc493d5500463b0e0af5ff.tar.gz
cpython-2a8b54d29cc943e7b8bc493d5500463b0e0af5ff.tar.bz2
update peek documentation to implementation
-rw-r--r--Doc/library/io.rst8
1 files changed, 3 insertions, 5 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 26285b4..67a8d4d 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -504,11 +504,9 @@ Buffered Streams
.. method:: peek([n])
- Return 1 (or *n* if specified) bytes from a buffer without advancing the
- position. Only a single read on the raw stream is done to satisfy the
- call. The number of bytes returned may be less than requested since at
- most all the buffer's bytes from the current position to the end are
- returned.
+ Return bytes from the stream without advancing the position. Only a
+ single read on the raw stream is done to satisfy the call. The number of
+ bytes returned may be less or more than requested.
.. method:: read([n])