]> Cypherpunks repositories - gostls13.git/commitdiff
encoding/csv: clarify that Writer uses different line break than RFC 4180 by default
authornobishino <nobishii11@gmail.com>
Mon, 13 May 2024 21:31:18 +0000 (21:31 +0000)
committerGopher Robot <gobot@golang.org>
Mon, 13 May 2024 21:32:28 +0000 (21:32 +0000)
Package documentation of encoding/csv says:

> this package supports the format described in RFC 4180.

According to section 2 of RFC 4180:

> Each record is located on a separate line, delimited by a line break (CRLF).

On the other hand, Writer uses LF (not CRLF) as newline character by default.

> If [Writer.UseCRLF] is true, the Writer ends each output line with \r\n instead of \n.

Strictly speaking, this behavior is different from RFC 4180.
Package documentation would improve if we clarify that point.

Change-Id: I120e9332b593e1ac9ed8e49f6f8419ea88efc57d
GitHub-Last-Rev: 489167eb04331fa5c623f3da9041a9d34aa258ae
GitHub-Pull-Request: golang/go#67290
Reviewed-on: https://go-review.googlesource.com/c/go/+/584835
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
src/encoding/csv/reader.go

index d9cab865726c9a008b5c1742a0f2c3dad33086f1..df4702feded456038365fa59e51dd6fc8cff00aa 100644 (file)
@@ -4,7 +4,8 @@
 
 // Package csv reads and writes comma-separated values (CSV) files.
 // There are many kinds of CSV files; this package supports the format
-// described in RFC 4180.
+// described in RFC 4180, except that [Writer] uses LF
+// instead of CRLF as newline character by default.
 //
 // A csv file contains zero or more records of one or more fields per record.
 // Each record is separated by the newline character. The final record may