changed misleading argument name

This commit is contained in:
Fredrik Lundh 2001-10-18 20:58:25 +00:00
parent a4dc73e246
commit a5e616510e
2 changed files with 18 additions and 18 deletions

View file

@ -197,14 +197,14 @@ 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,\optional{fileHandle}}
\begin{methoddesc}{body}{id,\optional{file}}
Send a \samp{BODY} command, where \var{id} has the same meaning as for
\method{stat()}. If the \var{fileHandle} parameter is supplied, then
the body is stored in a file. If \var{fileHandle} is a string, then
\method{stat()}. If the \var{file} parameter is supplied, then
the body 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 close it.
If \var{fileHandle} is a file object, then it will start calling
If \var{file} 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
Return as for \method{head()}. If \var{file} is supplied. Then
the returned \var{list} is an empty list.
\end{methoddesc}