[Python-checkins] python/dist/src/Doc/lib libpickle.tex,1.51,1.52

akuchling at users.sourceforge.net akuchling at users.sourceforge.net
Sat Aug 7 22:25:58 CEST 2004


Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18103

Modified Files:
	libpickle.tex 
Log Message:
[Patch #999280 ] Update kwargs in pickle docs to match implementations

Index: libpickle.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpickle.tex,v
retrieving revision 1.51
retrieving revision 1.52
diff -C2 -d -r1.51 -r1.52
*** libpickle.tex	7 Aug 2004 16:24:18 -0000	1.51
--- libpickle.tex	7 Aug 2004 20:25:55 -0000	1.52
***************
*** 171,180 ****
  following functions to make this process more convenient:
  
! \begin{funcdesc}{dump}{object, file\optional{, protocol\optional{, bin}}}
! Write a pickled representation of \var{object} to the open file object
  \var{file}.  This is equivalent to
! \code{Pickler(\var{file}, \var{protocol}, \var{bin}).dump(\var{object})}.
  
! If the \var{protocol} parameter is ommitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value
  or \constant{HIGHEST_PROTOCOL},
--- 171,180 ----
  following functions to make this process more convenient:
  
! \begin{funcdesc}{dump}{obj, file\optional{, protocol\optional{, bin}}}
! Write a pickled representation of \var{obj} to the open file object
  \var{file}.  This is equivalent to
! \code{Pickler(\var{file}, \var{protocol}, \var{bin}).dump(\var{obj})}.
  
! If the \var{protocol} parameter is omitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value
  or \constant{HIGHEST_PROTOCOL},
***************
*** 212,220 ****
  \end{funcdesc}
  
! \begin{funcdesc}{dumps}{object\optional{, protocol\optional{, bin}}}
  Return the pickled representation of the object as a string, instead
  of writing it to a file.
  
! If the \var{protocol} parameter is ommitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value
  or \constant{HIGHEST_PROTOCOL},
--- 212,220 ----
  \end{funcdesc}
  
! \begin{funcdesc}{dumps}{obj\optional{, protocol\optional{, bin}}}
  Return the pickled representation of the object as a string, instead
  of writing it to a file.
  
! If the \var{protocol} parameter is omitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value
  or \constant{HIGHEST_PROTOCOL},
***************
*** 267,271 ****
  stream.  
  
! If the \var{protocol} parameter is ommitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value,
  the highest protocol version will be used.
--- 267,271 ----
  stream.  
  
! If the \var{protocol} parameter is omitted, protocol 0 is used.
  If \var{protocol} is specified as a negative value,
  the highest protocol version will be used.
***************
*** 287,292 ****
  \class{Pickler} objects define one (or two) public methods:
  
! \begin{methoddesc}[Pickler]{dump}{object}
! Write a pickled representation of \var{object} to the open file object
  given in the constructor.  Either the binary or \ASCII{} format will
  be used, depending on the value of the \var{bin} flag passed to the
--- 287,292 ----
  \class{Pickler} objects define one (or two) public methods:
  
! \begin{methoddesc}[Pickler]{dump}{obj}
! Write a pickled representation of \var{obj} to the open file object
  given in the constructor.  Either the binary or \ASCII{} format will
  be used, depending on the value of the \var{bin} flag passed to the



More information about the Python-checkins mailing list