]> granicus.if.org Git - python/commitdiff
Docs for SF patch #462628
authorGuido van Rossum <guido@python.org>
Mon, 1 Oct 2001 13:50:15 +0000 (13:50 +0000)
committerGuido van Rossum <guido@python.org>
Mon, 1 Oct 2001 13:50:15 +0000 (13:50 +0000)
Doc/lib/libnntplib.tex

index 011524ba91c528047616951d1010f3639a81606b..bf26b7d609bf77dea51495e358d84aec348e648e 100644 (file)
@@ -197,9 +197,15 @@ and \var{list} is a list of the article's headers (an uninterpreted
 list of lines, without trailing newlines).
 \end{methoddesc}
 
-\begin{methoddesc}{body}{id}
+\begin{methoddesc}{body}{id,\optional{fileHandle}}
 Send a \samp{BODY} command, where \var{id} has the same meaning as for
-\method{stat()}.  Return as for \method{head()}.
+\method{stat()}.  If the \var{fileHandle} parameter is supplied, then
+the body is stored in a file.  If \var{fileHandle} is a string, then
+the method will open a file object with that name, write to it then close it.
+If \var{fileHandle} is a file object, then it will start calling
+\method{write()} on it to store the lines of the body.
+Return as for \method{head()}.  If \var{fileHandle} is supplied. Then
+the returned \var{list} is an empty list.
 \end{methoddesc}
 
 \begin{methoddesc}{article}{id}