Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e5cf53a

Browse files
committed
Formatting nits.
An index entry.
1 parent eb4ed15 commit e5cf53a

2 files changed

Lines changed: 22 additions & 12 deletions

File tree

Doc/lib/libimaplib.tex

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
\section{Standard Module \module{imaplib}}
77
\stmodindex{imaplib}
88
\label{module-imaplib}
9+
\indexii{IMAP4}{protocol}
910

1011
This module defines a class, \class{IMAP4}, which encapsulates a
1112
connection to an IMAP4 server and implements the IMAP4rev1 client
@@ -117,9 +118,11 @@ \subsection{IMAP4 Objects}
117118
envelope and data.
118119
\end{methoddesc}
119120

120-
\begin{methoddesc}{list}{directory='""', pattern='*'}
121-
List mailbox names in directory matching pattern. Returned data contains a
122-
list of \samp{LIST} responses.
121+
\begin{methoddesc}{list}{\optional{directory\optional{, pattern}}}
122+
List mailbox names in \var{directory} matching
123+
\var{pattern}. \var{directory} defaults to the top-level mail
124+
folder, and \var{pattern} defaults to match anything. Returned data
125+
contains a list of \samp{LIST} responses.
123126
\end{methoddesc}
124127

125128
\begin{methoddesc}{login}{user, password}
@@ -130,9 +133,11 @@ \subsection{IMAP4 Objects}
130133
Shutdown connection to server. Returns server \samp{BYE} response.
131134
\end{methoddesc}
132135

133-
\begin{methoddesc}{lsub}{directory='""', pattern='*'}
134-
List subscribed mailbox names in directory matching
135-
pattern. Returned data are tuples of message part envelope and data.
136+
\begin{methoddesc}{lsub}{\optional{directory\optional{, pattern}}}
137+
List subscribed mailbox names in directory matching pattern.
138+
\var{directory} defaults to the top level directory and
139+
\var{pattern} defaults to match any mailbox.
140+
Returned data are tuples of message part envelope and data.
136141
\end{methoddesc}
137142

138143
\begin{methoddesc}{recent}{}

Doc/libimaplib.tex

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
\section{Standard Module \module{imaplib}}
77
\stmodindex{imaplib}
88
\label{module-imaplib}
9+
\indexii{IMAP4}{protocol}
910

1011
This module defines a class, \class{IMAP4}, which encapsulates a
1112
connection to an IMAP4 server and implements the IMAP4rev1 client
@@ -117,9 +118,11 @@ \subsection{IMAP4 Objects}
117118
envelope and data.
118119
\end{methoddesc}
119120

120-
\begin{methoddesc}{list}{directory='""', pattern='*'}
121-
List mailbox names in directory matching pattern. Returned data contains a
122-
list of \samp{LIST} responses.
121+
\begin{methoddesc}{list}{\optional{directory\optional{, pattern}}}
122+
List mailbox names in \var{directory} matching
123+
\var{pattern}. \var{directory} defaults to the top-level mail
124+
folder, and \var{pattern} defaults to match anything. Returned data
125+
contains a list of \samp{LIST} responses.
123126
\end{methoddesc}
124127

125128
\begin{methoddesc}{login}{user, password}
@@ -130,9 +133,11 @@ \subsection{IMAP4 Objects}
130133
Shutdown connection to server. Returns server \samp{BYE} response.
131134
\end{methoddesc}
132135

133-
\begin{methoddesc}{lsub}{directory='""', pattern='*'}
134-
List subscribed mailbox names in directory matching
135-
pattern. Returned data are tuples of message part envelope and data.
136+
\begin{methoddesc}{lsub}{\optional{directory\optional{, pattern}}}
137+
List subscribed mailbox names in directory matching pattern.
138+
\var{directory} defaults to the top level directory and
139+
\var{pattern} defaults to match any mailbox.
140+
Returned data are tuples of message part envelope and data.
136141
\end{methoddesc}
137142

138143
\begin{methoddesc}{recent}{}

0 commit comments

Comments
 (0)