summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-04-28 19:59:22 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-04-28 19:59:22 (GMT)
commitf34c4c6a7787cbc0fa820a90866fcf18b38818ee (patch)
tree255984d3638260be2c43f5a1cb80929874e8817f
parent379eaac7a7850ff0e05c2af161cda497e639718a (diff)
downloadcpython-f34c4c6a7787cbc0fa820a90866fcf18b38818ee.zip
cpython-f34c4c6a7787cbc0fa820a90866fcf18b38818ee.tar.gz
cpython-f34c4c6a7787cbc0fa820a90866fcf18b38818ee.tar.bz2
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() ........
-rw-r--r--Doc/library/io.rst15
1 files changed, 7 insertions, 8 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index a8a4068..1a4b959 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -226,8 +226,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
@@ -293,7 +295,9 @@ 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`.
+ 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()
@@ -467,11 +471,6 @@ Buffered Streams
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])