[Python-checkins] CVS: python/dist/src/Doc/lib libcookie.tex,1.5,1.6

Fred L. Drake fdrake@users.sourceforge.net
Fri, 29 Jun 2001 09:21:49 -0700


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

Modified Files:
	libcookie.tex 
Log Message:

Removed some stray periods, and fix up a number of visible markup
consistency errors (mostly omitted "()" at the end of function and
method names).

Reported by Milan Zamazal <pdm@zamazal.org>.


Index: libcookie.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcookie.tex,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** libcookie.tex	2001/01/18 07:50:17	1.5
--- libcookie.tex	2001/06/29 16:21:47	1.6
***************
*** 29,44 ****
  the key and the value.
  
! If \var{input} is given, it is passed to the \method{load} method.
  \end{classdesc}
  
  \begin{classdesc}{SimpleCookie}{\optional{input}}
! This class derives from \class{BaseCookie} and overrides \method{value_decode}
! and \method{value_encode} to be the identity and \function{str()} respectively.
  \end{classdesc}
  
  \begin{classdesc}{SerialCookie}{\optional{input}}
! This class derives from \class{BaseCookie} and overrides \method{value_decode}
! and \method{value_encode} to be the \function{pickle.loads()} and 
! \function{pickle.dumps}.  
  
  Do not use this class.  Reading pickled values from a cookie is a
--- 29,45 ----
  the key and the value.
  
! If \var{input} is given, it is passed to the \method{load()} method.
  \end{classdesc}
  
  \begin{classdesc}{SimpleCookie}{\optional{input}}
! This class derives from \class{BaseCookie} and overrides
! \method{value_decode()} and \method{value_encode()} to be the identity
! and \function{str()} respectively.
  \end{classdesc}
  
  \begin{classdesc}{SerialCookie}{\optional{input}}
! This class derives from \class{BaseCookie} and overrides
! \method{value_decode()} and \method{value_encode()} to be the
! \function{pickle.loads()} and  \function{pickle.dumps()}.  
  
  Do not use this class.  Reading pickled values from a cookie is a
***************
*** 50,58 ****
  
  \begin{classdesc}{SmartCookie}{\optional{input}}
! This class derives from \class{BaseCookie}. It overrides \method{value_decode}
! to be \function{pickle.loads()} if it is a valid pickle, and otherwise
! the value itself. It overrides \method{value_encode} to be 
! \function{pickle.dumps()} unless it is a string, in which case it returns
! the value itself.
  
  The same security warning from \class{SerialCookie} applies here.
--- 51,59 ----
  
  \begin{classdesc}{SmartCookie}{\optional{input}}
! This class derives from \class{BaseCookie}. It overrides
! \method{value_decode()} to be \function{pickle.loads()} if it is a
! valid pickle, and otherwise the value itself. It overrides
! \method{value_encode()} to be \function{pickle.dumps()} unless it is a
! string, in which case it returns the value itself.
  
  The same security warning from \class{SerialCookie} applies here.
***************
*** 79,91 ****
  so it can be overridden
  
! In general, it should be the case that \method{value_encode} and 
! \method{value_decode} are inverses on the range of \var{value_decode}.
! \end{methoddesc}.
  
  \begin{methoddesc}[BaseCookie]{output}{\optional{attrs\optional{, header\optional{, sep}}}}
  Return a string representation suitable to be sent as HTTP headers.
! \var{attrs} and \var{header} are sent to each \class{Morsel}'s \method{output}
! method. \var{sep} is used to join the headers together, and is by default
! a newline.
  \end{methoddesc}
  
--- 80,92 ----
  so it can be overridden
  
! In general, it should be the case that \method{value_encode()} and 
! \method{value_decode()} are inverses on the range of \var{value_decode}.
! \end{methoddesc}
  
  \begin{methoddesc}[BaseCookie]{output}{\optional{attrs\optional{, header\optional{, sep}}}}
  Return a string representation suitable to be sent as HTTP headers.
! \var{attrs} and \var{header} are sent to each \class{Morsel}'s
! \method{output()} method. \var{sep} is used to join the headers
! together, and is by default a newline.
  \end{methoddesc}
  
***************
*** 162,166 ****
  
  The meaning for \var{attrs} is the same as in \method{output()}.
! \end{methoddesc}.
  
  \begin{methoddesc}[Morsel]{OutputString}{\optional{attrs}}
--- 163,167 ----
  
  The meaning for \var{attrs} is the same as in \method{output()}.
! \end{methoddesc}
  
  \begin{methoddesc}[Morsel]{OutputString}{\optional{attrs}}