]> granicus.if.org Git - python/commitdiff
Merged revisions 75168 via svnmerge from
authorAntoine Pitrou <solipsis@pitrou.net>
Thu, 1 Oct 2009 16:27:13 +0000 (16:27 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Thu, 1 Oct 2009 16:27:13 +0000 (16:27 +0000)
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r75168 | antoine.pitrou | 2009-10-01 18:24:45 +0200 (jeu., 01 oct. 2009) | 3 lines

  Issue #7022: clarification of RawIOBase.read(), suggested by Pascal Chambon.
........

Doc/library/io.rst

index 6432d99751b6e6c9f06ec4e7bab1468f9c0486f2..5188b51b6addaaa34378809a66cca9bfb9e91d41 100644 (file)
@@ -326,11 +326,14 @@ I/O Base Classes
 
    .. method:: read(n=-1)
 
-      Read and return up to *n* bytes from the stream.  As a convenience, if
-      *n* is unspecified or -1, :meth:`readall` is called.  Otherwise,
-      only one system call is ever made.  An empty bytes object is returned
-      on EOF; ``None`` is returned if the object is set not to block and has
-      no data to read.
+      Read up to *n* bytes from the object and return them.  As a convenience,
+      if *n* is unspecified or -1, :meth:`readall` is called.  Otherwise,
+      only one system call is ever made.  Fewer than *n* bytes may be
+      returned if the operating system call returns fewer than *n* bytes.
+
+      If 0 bytes are returned, and *n* was not 0, this indicates end of file.
+      If the object is in non-blocking mode and no bytes are available,
+      ``None`` is returned.
 
    .. method:: readall()