traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

- Bug #1015140: disambiguated the term "article id" in nntplib docs and 

docstrings to either "article number" or "message id".
This commit is contained in:
Georg Brandl 2005-07-17 20:27:41 +00:00
parent 0e03272350
commit 5dbda75a02
3 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/lib/libnntplib.tex
View File

@ -156,7 +156,7 @@ If \var{file} is supplied, then the returned \var{list} is an empty list.
Send a \samp{NEWNEWS} command. Here, \var{group} is a group name or Send a \samp{NEWNEWS} command. Here, \var{group} is a group name or
\code{'*'}, and \var{date} and \var{time} have the same meaning as for \code{'*'}, and \var{date} and \var{time} have the same meaning as for
\method{newgroups()}. Return a pair \code{(\var{response}, \method{newgroups()}. Return a pair \code{(\var{response},
\var{articles})} where \var{articles} is a list of article ids. \var{articles})} where \var{articles} is a list of message ids.
If the \var{file} parameter is supplied, then the output of the If the \var{file} parameter is supplied, then the output of the
\samp{NEWNEWS} command is stored in a file. If \var{file} is a string, \samp{NEWNEWS} command is stored in a file. If \var{file} is a string,
then the method will open a file object with that name, write to it then the method will open a file object with that name, write to it
@ -228,7 +228,7 @@ Send a \samp{STAT} command, where \var{id} is the message id (enclosed
in \character{<} and \character{>}) or an article number (as a string). in \character{<} and \character{>}) or an article number (as a string).
Return a triple \code{(\var{response}, \var{number}, \var{id})} where Return a triple \code{(\var{response}, \var{number}, \var{id})} where
\var{number} is the article number (as a string) and \var{id} is the \var{number} is the article number (as a string) and \var{id} is the
article id (enclosed in \character{<} and \character{>}). message id (enclosed in \character{<} and \character{>}).
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{next}{} \begin{methoddesc}{next}{}
@ -275,7 +275,7 @@ keyword, e.g. \code{'subject'}. The \var{string} argument should have
the form \code{'\var{first}-\var{last}'} where \var{first} and the form \code{'\var{first}-\var{last}'} where \var{first} and
\var{last} are the first and last article numbers to search. Return a \var{last} are the first and last article numbers to search. Return a
pair \code{(\var{response}, \var{list})}, where \var{list} is a list of pair \code{(\var{response}, \var{list})}, where \var{list} is a list of
pairs \code{(\var{id}, \var{text})}, where \var{id} is an article id pairs \code{(\var{id}, \var{text})}, where \var{id} is an article number
(as a string) and \var{text} is the text of the requested header for (as a string) and \var{text} is the text of the requested header for
that article. that article.
If the \var{file} parameter is supplied, then the output of the If the \var{file} parameter is supplied, then the output of the
@ -295,7 +295,9 @@ automatically escapes lines beginning with \samp{.}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}{ihave}{id, file} \begin{methoddesc}{ihave}{id, file}
Send an \samp{IHAVE} command. If the response is not an error, treat Send an \samp{IHAVE} command. \var{id} is a message id (enclosed in
\character{<} and \character{>}).
If the response is not an error, treat
\var{file} exactly as for the \method{post()} method. \var{file} exactly as for the \method{post()} method.
\end{methoddesc} \end{methoddesc}

4
Lib/nntplib.py
View File

@ -281,7 +281,7 @@ class NNTP:
- time: string 'hhmmss' indicating the time - time: string 'hhmmss' indicating the time
Return: Return:
- resp: server response if successful - resp: server response if successful
- list: list of article ids""" - list: list of message ids"""
cmd = 'NEWNEWS ' + group + ' ' + date + ' ' + time cmd = 'NEWNEWS ' + group + ' ' + date + ' ' + time
return self.longcmd(cmd, file) return self.longcmd(cmd, file)
@ -391,7 +391,7 @@ class NNTP:
Returns: Returns:
- resp: server response if successful - resp: server response if successful
- nr: the article number - nr: the article number
- id: the article id""" - id: the message id"""
return self.statcmd('STAT ' + id) return self.statcmd('STAT ' + id)

3
Misc/NEWS
View File

@ -168,6 +168,9 @@ Extension Modules
Library Library
------- -------
- Bug #1015140: disambiguated the term "article id" in nntplib docs and
docstrings to either "article number" or "message id".
- Bug #1238170: threading.Thread.__init__ no longer has "kwargs={}" as a - Bug #1238170: threading.Thread.__init__ no longer has "kwargs={}" as a
parameter, but uses the usual "kwargs=None". parameter, but uses the usual "kwargs=None".