From: Raymond Hettinger <python@rcn.com>
Date: Thu, 16 May 2002 04:33:33 +0000 (+0000)
Subject: Patch 547037.  Corrected documentation to match
X-Git-Tag: v2.2.2b1~365
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c382a45120b652b76d5b75134a1ba4d459227912;p=thirdparty%2FPython%2Fcpython.git

Patch 547037.  Corrected documentation to match
actual module behavior for adding newlines.
---

diff --git a/Doc/lib/libbase64.tex b/Doc/lib/libbase64.tex
index 612da4c52aed..91f4818d1ef6 100644
--- a/Doc/lib/libbase64.tex
+++ b/Doc/lib/libbase64.tex
@@ -40,21 +40,19 @@ Encode the contents of the \var{input} file and write the resulting
 base64 encoded data to the \var{output} file.
 \var{input} and \var{output} must either be file objects or objects that
 mimic the file object interface. \var{input} will be read until
-\code{\var{input}.read()} returns an empty string.  If the last input
-character is not a newline (\code{'\e n'}), a newline will be added to
-the input data.
+\code{\var{input}.read()} returns an empty string.  \function{encode()}
+returns the encoded data plus a trailing newline character
+(\code{'\e n'}).
 \end{funcdesc}
 
 \begin{funcdesc}{encodestring}{s}
 Encode the string \var{s}, which can contain arbitrary binary data,
 and return a string containing one or more lines of
-base64-encoded data.  If the last character of \var{s} is not a
-newline (\code{'\e n'}), a newline will be added.  This causes
-\code{encodestring('hello!')} to return the same value as
-\code{encodestring('hello!\e n')}.
+base64-encoded data.  \function{encodestring()} returns a
+string containing one or more lines of base64-encoded data
+always including an extra trailing newline (\code{'\e n'}).
 \end{funcdesc}
 
-
 \begin{seealso}
   \seemodule{binascii}{Support module containing \ASCII-to-binary
                        and binary-to-\ASCII{} conversions.}