summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2011-02-07 16:03:24 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2011-02-07 16:03:24 (GMT)
commitb248bdca9614c87ef7958bea4cc34d3cbd3ced11 (patch)
tree0d2d735f2060c6b8000aa5337908490b344a1352
parent8095b6548b3b0e69fc24574ca56ac8654495f4ec (diff)
downloadcpython-b248bdca9614c87ef7958bea4cc34d3cbd3ced11.zip
cpython-b248bdca9614c87ef7958bea4cc34d3cbd3ced11.tar.gz
cpython-b248bdca9614c87ef7958bea4cc34d3cbd3ced11.tar.bz2
Merged revisions 88371 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r88371 | antoine.pitrou | 2011-02-07 16:58:11 +0100 (lun., 07 févr. 2011) | 3 lines Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls shutdown(). ........
-rw-r--r--Doc/library/imaplib.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst
index b8ac03d..04088ac 100644
--- a/Doc/library/imaplib.rst
+++ b/Doc/library/imaplib.rst
@@ -288,9 +288,10 @@ An :class:`IMAP4` instance has the following methods:
.. method:: IMAP4.open(host, port)
- Opens socket to *port* at *host*. The connection objects established by this
+ Opens socket to *port* at *host*. This method is implicitly called by
+ the :class:`IMAP4` constructor. The connection objects established by this
method will be used in the ``read``, ``readline``, ``send``, and ``shutdown``
- methods. You may override this method.
+ methods. You may override this method.
.. method:: IMAP4.partial(message_num, message_part, start, length)
@@ -380,7 +381,8 @@ An :class:`IMAP4` instance has the following methods:
.. method:: IMAP4.shutdown()
- Close connection established in ``open``. You may override this method.
+ Close connection established in ``open``. This method is implicitly
+ called by :meth:`IMAP4.logout`. You may override this method.
.. method:: IMAP4.socket()