]> granicus.if.org Git - python/commitdiff
Merged revisions 81595 via svnmerge from
authorAntoine Pitrou <solipsis@pitrou.net>
Sat, 29 May 2010 12:10:15 +0000 (12:10 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Sat, 29 May 2010 12:10:15 +0000 (12:10 +0000)
svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r81595 | antoine.pitrou | 2010-05-29 14:08:25 +0200 (sam., 29 mai 2010) | 9 lines

  Merged revisions 81594 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r81594 | antoine.pitrou | 2010-05-29 14:06:13 +0200 (sam., 29 mai 2010) | 3 lines

    Issue #8840: Make documentation for truncate() clearer
  ........
................

Doc/library/io.rst

index 8bbd6cb7533392ff6640096afc101935f8bed1ab..3e98ca9a02fd7a1ac07e74b2499ef24b042e8929 100644 (file)
@@ -309,10 +309,12 @@ 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`.  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.
+      Resize the stream to the given *size* in bytes (or the current position
+      if *size* is not specified).  The current stream position isn't changed.
+      This resizing can extend or reduce the current file size.  In case of
+      extension, the contents of the new file area depend on the platform
+      (on most systems, additional bytes are zero-filled, on Windows they're
+      undetermined).  The new file size is returned.
 
    .. method:: writable()