From: Skip Montanaro <skip@pobox.com>
Date: Sat, 29 Jul 2006 20:06:05 +0000 (+0000)
Subject: Add a comment to the csv reader documentation that explains why the
X-Git-Tag: v2.5b3~69
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=abd51a358561b52d4d9ddc75b82b9749a3aba55a;p=python

Add a comment to the csv reader documentation that explains why the
treatment of newlines changed in 2.5.  Pulled almost verbatim from a comment
by Andrew McNamara in <http://python.org/sf/1465014>.
---

diff --git a/Doc/lib/libcsv.tex b/Doc/lib/libcsv.tex
index 65053c7f1b..0e3294b76e 100644
--- a/Doc/lib/libcsv.tex
+++ b/Doc/lib/libcsv.tex
@@ -70,6 +70,17 @@ Parameters'' for details of these parameters.
 
 All data read are returned as strings.  No automatic data type
 conversion is performed.
+
+\versionchanged[
+If literal newlines are important within a field, users need to read their
+file in a way that preserves the newlines. The behavior before 2.5 would
+introduce spurious characters into quoted fields, with no way for the user
+to control that behavior. The previous behavior caused considerable
+problems, particularly on platforms that did not use the unix line ending
+conventions, or with files that originated on those platforms - users were
+finding mysterious newlines where they didn't expect them.
+]{2.5}
+
 \end{funcdesc}
 
 \begin{funcdesc}{writer}{csvfile\optional{,