mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 18:51:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 21

Patch #605370: Add description[s] for RFC 2980 compliance.

Browse source
This commit is contained in:
Martin v. Löwis 2004-07-26 12:40:50 +00:00
parent 32d0c1b458
commit cc0f93233a
4 changed files with 60 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/lib/libnntplib.tex
View file

@ -175,6 +175,23 @@ then the method will open a file object with that name, write to it
then close it. If \var{file} is a file object, then it will start
calling \method{write()} on it to store the lines of the command output.
If \var{file} is supplied, then the returned \var{list} is an empty list.
\begin{methoddesc}{descriptions}{grouppattern}
Send a \samp{LIST NEWSGROUPS} command, where \var{grouppattern} is a wildmat
string as specified in RFC2980 (it's essentially the same as DOS or UNIX
shell wildcard strings). Return a pair \code{(\var{response},
\var{list})}, where \var{list} is a list of tuples containing
\code{(\var{name}, \var{title})}.
\end{methoddesc}
\begin{methoddesc}{description}{group}
Get a description for a single group \var{group}. If more than one group
matches (if 'group' is a real wildmat string), return the first match. If no group
matches, return an empty string.
This elides the response code from the server. If the response code is
needed, use \method{descriptions()}.
\end{methoddesc}
\begin{methoddesc}{group}{name}
@ -294,6 +311,9 @@ calling \method{write()} on it to store the lines of the command output.
If \var{file} is supplied, then the returned \var{list} is an empty list.
This is an optional NNTP extension, and may not be supported by all
servers.
RFC2980 says ``It is suggested that this extension be deprecated''. Use
\method{descriptions()} or \method{description()} instead.
\end{methoddesc}
\begin{methoddesc}{xover}{start, end, \optional{file}}