[Python-checkins] r80595 - in python/branches/release31-maint: Doc/library/io.rst

[antoine.pitrou]

Author: antoine.pitrou
Date: Wed Apr 28 22:03:21 2010
New Revision: 80595

Log:
Merged revisions 80594 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r80594 | antoine.pitrou | 2010-04-28 21:59:32 +0200 (mer., 28 avril 2010) | 14 lines
  
  Merged revisions 80591-80592 via svnmerge from 
  svn+ssh://pythondev@svn.python.org/python/trunk
  
  ........
    r80591 | antoine.pitrou | 2010-04-28 21:53:35 +0200 (mer., 28 avril 2010) | 4 lines
    
    State clearly that truncate() doesn't move the file position, 
    and remove a duplicate of its specification.
  ........
    r80592 | antoine.pitrou | 2010-04-28 21:57:33 +0200 (mer., 28 avril 2010) | 3 lines
    
    Clarify and fix the documentation for IOBase.close()
  ........
................


Modified:
   python/branches/release31-maint/   (props changed)
   python/branches/release31-maint/Doc/library/io.rst

Modified: python/branches/release31-maint/Doc/library/io.rst
==============================================================================
--- python/branches/release31-maint/Doc/library/io.rst	(original)
+++ python/branches/release31-maint/Doc/library/io.rst	Wed Apr 28 22:03:21 2010
@@ -235,8 +235,10 @@
 
       Flush and close this stream. This method has no effect if the file is
       already closed. Once the file is closed, any operation on the file
-      (e.g. reading or writing) will raise an :exc:`IOError`. The internal
-      file descriptor isn't closed if *closefd* was False.
+      (e.g. reading or writing) will raise an :exc:`ValueError`.
+
+      As a convenience, it is allowed to call this method more than once;
+      only the first call, however, will have an effect.
 
    .. attribute:: closed
 
@@ -308,7 +310,9 @@
    .. method:: truncate(size=None)
 
       Truncate the file to at most *size* bytes.  *size* defaults to the current
-      file position, as returned by :meth:`tell`.
+      file position, as returned by :meth:`tell`.  Note that the current file
+      position isn't changed; if you want to change it to the new end of
+      file, you have to :meth:`seek()` explicitly.
 
    .. method:: writable()
 
@@ -517,11 +521,6 @@
 
       In :class:`BytesIO`, this is the same as :meth:`read`.
 
-   .. method:: truncate([size])
-
-      Truncate the buffer to at most *size* bytes.  *size* defaults to the
-      current stream position, as returned by :meth:`tell`.
-
 
 .. class:: BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)