]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
backport some doc fixes
authorSkip Montanaro <skip@pobox.com>
Wed, 21 Jan 2004 13:49:43 +0000 (13:49 +0000)
committerSkip Montanaro <skip@pobox.com>
Wed, 21 Jan 2004 13:49:43 +0000 (13:49 +0000)
Doc/lib/libcsv.tex

index e2877ee6ad72651bf4a4569dbfad3a8270e7c6ba..1afe3c22a288bfb9edffb6f52aeb6dae5a5dd2fa 100644 (file)
@@ -228,7 +228,7 @@ A one-character string used to separate fields.  It defaults to \code{','}.
 
 \begin{memberdesc}[Dialect]{doublequote}
 Controls how instances of \var{quotechar} appearing inside a field should be
-themselves be quoted.  When \constant{True}, the character is doubledd.
+themselves be quoted.  When \constant{True}, the character is doubled.
 When \constant{False}, the \var{escapechar} must be a one-character string
 which is used as a prefix to the \var{quotechar}.  It defaults to
 \constant{True}.
@@ -274,8 +274,14 @@ according to the current dialect.
 
 \subsection{Writer Objects}
 
-Writer objects (\class{DictWriter} instances and objects returned by
-the \function{writer()} function) have the following public methods:
+\class{Writer} objects (\class{DictWriter} instances and objects returned by
+the \function{writer()} function) have the following public methods.  A
+{}\var{row} must be a sequence of strings or numbers for \class{Writer}
+objects and a dictionary mapping fieldnames to strings or numbers (by
+passing them through \function{str()} first) for {}\class{DictWriter}
+objects.  Note that complex numbers are written out surrounded by parens.
+This may cause some problems for other programs which read CSV files
+(assuming they support complex numbers at all).
 
 \begin{methoddesc}[csv writer]{writerow}{row}
 Write the \var{row} parameter to the writer's file object, formatted
@@ -283,7 +289,8 @@ according to the current dialect.
 \end{methoddesc}
 
 \begin{methoddesc}[csv writer]{writerows}{rows}
-Write all the \var{rows} parameters to the writer's file object, formatted
+Write all the \var{rows} parameters (a list of \var{row} objects as
+described above) to the writer's file object, formatted
 according to the current dialect.
 \end{methoddesc}