]> granicus.if.org Git - python/commitdiff
Merged revisions 80591-80592 via svnmerge from
authorAntoine Pitrou <solipsis@pitrou.net>
Wed, 28 Apr 2010 19:59:32 +0000 (19:59 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Wed, 28 Apr 2010 19:59:32 +0000 (19:59 +0000)
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()
........

Doc/library/io.rst

index 4511ce622cd4bea3be68b4939b5afb08439e1d77..451b33fe08f75f17861bc404f0bffeb3ffab5a1d 100644 (file)
@@ -240,8 +240,10 @@ I/O Base Classes
 
       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
 
@@ -313,7 +315,9 @@ I/O Base Classes
    .. 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()
 
@@ -522,11 +526,6 @@ In many situations, buffered I/O streams will provide higher performance
 
       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)