]> granicus.if.org Git - python/commitdiff
Merged revisions 88371 via svnmerge from
authorAntoine Pitrou <solipsis@pitrou.net>
Mon, 7 Feb 2011 16:03:24 +0000 (16:03 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Mon, 7 Feb 2011 16:03:24 +0000 (16:03 +0000)
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().
........

Doc/library/imaplib.rst

index b8ac03dece3ddc4780711b7fd78c82537bebc8ec..04088ac5aa519b80482a35b7197f832bc66e47c7 100644 (file)
@@ -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()