[Python-checkins] r70069 - python/branches/io-c/Doc/library/io.rst

[benjamin.peterson]

Author: benjamin.peterson
Date: Sat Feb 28 18:01:17 2009
New Revision: 70069

Log:
document read1() in BufferedIOBase

Modified:
   python/branches/io-c/Doc/library/io.rst

Modified: python/branches/io-c/Doc/library/io.rst
==============================================================================
--- python/branches/io-c/Doc/library/io.rst	(original)
+++ python/branches/io-c/Doc/library/io.rst	Sat Feb 28 18:01:17 2009
@@ -364,6 +364,11 @@
       A :exc:`BlockingIOError` is raised if the underlying raw stream has no
       data at the moment.
 
+   .. method:: read1([n])
+
+      Read and return up to *n* bytes, with at most one call to the underlying
+      raw stream's :meth:`~RawIOBase.read` method.
+
    .. method:: readinto(b)
 
       Read up to len(b) bytes into bytearray *b* and return the number of bytes