[Python-checkins] CVS: python/dist/src/Doc/lib libquopri.tex,1.12,1.13

[Barry Warsaw]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv20048

Modified Files:
	libquopri.tex 
Log Message:
Document the new encodestring() and decodestring() functions.  Also,
add some description of what the quotetabs argument does for the
encode*() functions.  Finally, add a "see also" pointing to the base64
module.


Index: libquopri.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libquopri.tex,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** libquopri.tex	2000/04/04 20:43:50	1.12
--- libquopri.tex	2001/06/19 19:44:42	1.13
***************
*** 22,26 ****
  \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.
  \end{funcdesc}
  
--- 22,26 ----
  \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}.readline()} returns an empty string.
  \end{funcdesc}
  
***************
*** 30,38 ****
  \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.
  \end{funcdesc}
  
  
  \begin{seealso}
    \seemodule{mimify}{General utilities for processing of MIME messages.}
  \end{seealso}
--- 30,55 ----
  \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}.readline()} returns an empty string.
! \var{quotetabs} is a flag which controls whether to encode embedded
! spaces and tabs; when true it encodes such embedded whitespace, and
! when false it leaves them unencoded.  Note that spaces and tabs
! appearing at the end of lines are always encoded, as per \rfc{1521}.
  \end{funcdesc}
  
+ \begin{funcdesc}{decodestring}{s}
+ Like \function{decode()}, except that it accepts a source string and
+ returns the corresponding decoded string.
+ \end{funcdesc}
+ 
+ \begin{funcdesc}{encodestring}{s\optional{, quotetabs}}
+ Like \function{encode()}, except that it accepts a source string and
+ returns the corresponding encoded string.  \var{quotetabs} is optional
+ (defaulting to 0), and is passed straight through to
+ \function{encode()}.
+ \end{funcdesc}
+ 
  
  \begin{seealso}
    \seemodule{mimify}{General utilities for processing of MIME messages.}
+   \seemodule{base64}{Encode and decode MIME base64 data}
  \end{seealso}