[Python-checkins] cpython (2.7): document IOBase.__del__'s behavior (closes #21764)

[benjamin.peterson]

http://hg.python.org/cpython/rev/4dca82f8d91d
changeset:   91183:4dca82f8d91d
branch:      2.7
parent:      91177:b4bab0788768
user:        Benjamin Peterson <benjamin at python.org>
date:        Sat Jun 14 18:51:34 2014 -0700
summary:
  document IOBase.__del__'s behavior (closes #21764)

Patch from Nikolaus Rath.

files:
  Doc/library/io.rst |  6 ++++++
  1 files changed, 6 insertions(+), 0 deletions(-)


diff --git a/Doc/library/io.rst b/Doc/library/io.rst
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -346,6 +346,12 @@
       is usual for each of the lines provided to have a line separator at the
       end.
 
+   .. method:: __del__()
+
+      Prepare for object destruction. :class:`IOBase` provides a default
+      implementation of this method that calls the instance's
+      :meth:`~IOBase.close` method.
+
 
 .. class:: RawIOBase
 

-- 
Repository URL: http://hg.python.org/cpython