From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sat, 29 May 2010 12:06:13 +0000 (+0000)
Subject: Issue #8840: Make documentation for truncate() clearer
X-Git-Tag: v2.7rc1~64
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9fe6199b4e898b3ad0d93690b64a59c7838567b0;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 63895bca56c7..c755a2b0a95d 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -320,10 +320,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()