From: Georg Brandl <georg@python.org>
Date: Sun, 17 Jul 2005 20:26:33 +0000 (+0000)
Subject: backport Bug #1015140: disambiguated the term "article id" in nntplib docs and
X-Git-Tag: v2.4.2c1~133
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c10be809ec1c582ed219ef4bdff1ba248ad38417;p=thirdparty%2FPython%2Fcpython.git

backport Bug #1015140: disambiguated the term "article id" in nntplib docs and
  docstrings to either "article number" or "message id".
---

diff --git a/Doc/lib/libnntplib.tex b/Doc/lib/libnntplib.tex
index 1aa5d4342060..7f14deeac77e 100644
--- a/Doc/lib/libnntplib.tex
+++ b/Doc/lib/libnntplib.tex
@@ -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
 \code{'*'}, and \var{date} and \var{time} have the same meaning as for
 \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 
 \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 
@@ -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).
 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
-article id  (enclosed in \character{<} and \character{>}).
+message id  (enclosed in \character{<} and \character{>}).
 \end{methoddesc}
 
 \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
 \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
-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
 that article.
 If the \var{file} parameter is supplied, then the output of the 
@@ -295,7 +295,9 @@ automatically escapes lines beginning with \samp{.}.
 \end{methoddesc}
 
 \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.
 \end{methoddesc}
 
diff --git a/Lib/nntplib.py b/Lib/nntplib.py
index 8709fffc6432..cc51d1da8225 100644
--- a/Lib/nntplib.py
+++ b/Lib/nntplib.py
@@ -281,7 +281,7 @@ class NNTP:
         - time: string 'hhmmss' indicating the time
         Return:
         - resp: server response if successful
-        - list: list of article ids"""
+        - list: list of message ids"""
 
         cmd = 'NEWNEWS ' + group + ' ' + date + ' ' + time
         return self.longcmd(cmd, file)
@@ -391,7 +391,7 @@ class NNTP:
         Returns:
         - resp: server response if successful
         - nr:   the article number
-        - id:   the article id"""
+        - id:   the message id"""
 
         return self.statcmd('STAT ' + id)
 
diff --git a/Misc/NEWS b/Misc/NEWS
index 2b4328d0403f..875c148a91cf 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -51,6 +51,9 @@ Extension Modules
 Library
 -------
 
+- Bug #1015140: disambiguated the term "article id" in nntplib docs and
+  docstrings to either "article number" or "message id".
+
 - Bug #1177468: Don't cache the /dev/urandom file descriptor for os.urandom,
   as this can cause problems with apps closing all file descriptors.