]> granicus.if.org Git - python/commitdiff
Formatting nits.
authorFred Drake <fdrake@acm.org>
Sat, 11 Apr 1998 05:02:45 +0000 (05:02 +0000)
committerFred Drake <fdrake@acm.org>
Sat, 11 Apr 1998 05:02:45 +0000 (05:02 +0000)
An index entry.

Doc/lib/libimaplib.tex
Doc/libimaplib.tex

index 7cb4bb3c193b52f6e3108f5bff4988e366306ea9..44f5fb77be645b8e115205aaba9ee323b5eb30e5 100644 (file)
@@ -6,6 +6,7 @@
 \section{Standard Module \module{imaplib}}
 \stmodindex{imaplib}
 \label{module-imaplib}
+\indexii{IMAP4}{protocol}
 
 This module defines a class, \class{IMAP4}, which encapsulates a
 connection to an IMAP4 server and implements the IMAP4rev1 client
@@ -117,9 +118,11 @@ An \class{IMAP4} instance has the following methods:
   envelope and data.
 \end{methoddesc}
 
-\begin{methoddesc}{list}{directory='""', pattern='*'}
-  List mailbox names in directory matching pattern. Returned data contains a
-  list of \samp{LIST} responses.
+\begin{methoddesc}{list}{\optional{directory\optional{, pattern}}}
+  List mailbox names in \var{directory} matching
+  \var{pattern}.  \var{directory} defaults to the top-level mail
+  folder, and \var{pattern} defaults to match anything.  Returned data
+  contains a list of \samp{LIST} responses.
 \end{methoddesc}
 
 \begin{methoddesc}{login}{user, password}
@@ -130,9 +133,11 @@ An \class{IMAP4} instance has the following methods:
   Shutdown connection to server. Returns server \samp{BYE} response.
 \end{methoddesc}
 
-\begin{methoddesc}{lsub}{directory='""', pattern='*'}
-  List subscribed mailbox names in directory matching
-  pattern. Returned data are tuples of message part envelope and data.
+\begin{methoddesc}{lsub}{\optional{directory\optional{, pattern}}}
+  List subscribed mailbox names in directory matching pattern.
+  \var{directory} defaults to the top level directory and
+  \var{pattern} defaults to match any mailbox.
+  Returned data are tuples of message part envelope and data.
 \end{methoddesc}
 
 \begin{methoddesc}{recent}{}
index 7cb4bb3c193b52f6e3108f5bff4988e366306ea9..44f5fb77be645b8e115205aaba9ee323b5eb30e5 100644 (file)
@@ -6,6 +6,7 @@
 \section{Standard Module \module{imaplib}}
 \stmodindex{imaplib}
 \label{module-imaplib}
+\indexii{IMAP4}{protocol}
 
 This module defines a class, \class{IMAP4}, which encapsulates a
 connection to an IMAP4 server and implements the IMAP4rev1 client
@@ -117,9 +118,11 @@ An \class{IMAP4} instance has the following methods:
   envelope and data.
 \end{methoddesc}
 
-\begin{methoddesc}{list}{directory='""', pattern='*'}
-  List mailbox names in directory matching pattern. Returned data contains a
-  list of \samp{LIST} responses.
+\begin{methoddesc}{list}{\optional{directory\optional{, pattern}}}
+  List mailbox names in \var{directory} matching
+  \var{pattern}.  \var{directory} defaults to the top-level mail
+  folder, and \var{pattern} defaults to match anything.  Returned data
+  contains a list of \samp{LIST} responses.
 \end{methoddesc}
 
 \begin{methoddesc}{login}{user, password}
@@ -130,9 +133,11 @@ An \class{IMAP4} instance has the following methods:
   Shutdown connection to server. Returns server \samp{BYE} response.
 \end{methoddesc}
 
-\begin{methoddesc}{lsub}{directory='""', pattern='*'}
-  List subscribed mailbox names in directory matching
-  pattern. Returned data are tuples of message part envelope and data.
+\begin{methoddesc}{lsub}{\optional{directory\optional{, pattern}}}
+  List subscribed mailbox names in directory matching pattern.
+  \var{directory} defaults to the top level directory and
+  \var{pattern} defaults to match any mailbox.
+  Returned data are tuples of message part envelope and data.
 \end{methoddesc}
 
 \begin{methoddesc}{recent}{}