diff Doc/lib/libcsv.tex @ 29169:434ef174f478 legacy-trunk

* Correct Sniffer doc to correspond to the implementation. * Add optional delimiters arg to Sniffer.sniff() which restricts the set of candidate field delimiters.
author Skip Montanaro <skip@pobox.com>
date Mon, 19 May 2003 15:33:36 +0000
parents 1bef3eca20ce
children fdac9b4d3717
line wrap: on
line diff
--- a/Doc/lib/libcsv.tex	Mon May 19 02:07:44 2003 +0000
+++ b/Doc/lib/libcsv.tex	Mon May 19 15:33:36 2003 +0000
@@ -152,17 +152,17 @@
 \class{reader} or \class{writer} instance.
 \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.
+\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}{fileobj}
-Analyze the next chunk of \var{fileobj} and return a \class{Dialect} subclass
-reflecting the parameters found.
+\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}
 
 \begin{methoddesc}{has_header}{sample}