Patch 547037. Corrected documentation to match

actual module behavior for adding newlines.
This commit is contained in:
Raymond Hettinger 2002-05-16 04:28:44 +00:00
parent 1e1fcef756
commit cadc9fbd37
1 changed files with 6 additions and 8 deletions

View File

@ -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.}