From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sat, 29 May 2010 12:08:31 +0000 (+0000)
Subject: Merged revisions 81594 via svnmerge from
X-Git-Tag: v2.6.6rc1~233
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ae15f1754a31c96a948fe5a661a7f5452e9a1652;p=python

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
........
---

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 1a4b959ebf..e3f8b36a09 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -294,10 +294,12 @@ I/O Base Classes
 
    .. method:: truncate([size])
 
-      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()