update peek documentation to implementation

This commit is contained in:
Benjamin Peterson 2009-06-14 14:37:23 +00:00
parent 3d8827dab6
commit 2a8b54d29c

View file

@ -504,11 +504,9 @@ Buffered Streams
.. method:: peek([n]) .. method:: peek([n])
Return 1 (or *n* if specified) bytes from a buffer without advancing the Return bytes from the stream without advancing the position. Only a
position. Only a single read on the raw stream is done to satisfy the single read on the raw stream is done to satisfy the call. The number of
call. The number of bytes returned may be less than requested since at bytes returned may be less or more than requested.
most all the buffer's bytes from the current position to the end are
returned.
.. method:: read([n]) .. method:: read([n])