[Python-checkins] python/dist/src/Doc/lib libcsv.tex,1.4,1.5

[montanaro@users.sourceforge.net]

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

Modified Files:
	libcsv.tex 
Log Message:
* Correct Sniffer doc to correspond to the implementation.

* Add optional delimiters arg to Sniffer.sniff() which restricts the set of
  candidate field delimiters.



Index: libcsv.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcsv.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** libcsv.tex	25 Apr 2003 18:02:34 -0000	1.4
--- libcsv.tex	19 May 2003 15:33:36 -0000	1.5
***************
*** 153,167 ****
  \end{classdesc*}
  
! \begin{classdesc}{Sniffer}{\optional{sample=16384}}
! The \class{Sniffer} class is used to deduce the format of a CSV file.  The
! optional \var{sample} argument to the constructor specifies the number of
! bytes to use when determining Dialect parameters.
  \end{classdesc}
  
  The \class{Sniffer} class provides a single method:
  
! \begin{methoddesc}{sniff}{fileobj}
! Analyze the next chunk of \var{fileobj} and return a \class{Dialect} subclass
! reflecting the parameters found.
  \end{methoddesc}
  
--- 153,167 ----
  \end{classdesc*}
  
! \begin{classdesc}{Sniffer}{}
! The \class{Sniffer} class is used to deduce the format of a CSV file.
  \end{classdesc}
  
  The \class{Sniffer} class provides a single method:
  
! \begin{methoddesc}{sniff}{sample\optional{,delimiters=None}}
! Analyze the given \var{sample} and return a \class{Dialect} subclass
! reflecting the parameters found.  If the optional \var{delimiters} parameter
! is given, it is interpreted as a string containing possible valid delimiter
! characters.
  \end{methoddesc}