aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2012-02-08 14:24:04 +1100
committerRob Pike <r@golang.org>2012-02-08 14:24:04 +1100
commit90d43ad720a4669878bcabf14c4ea915557c0545 (patch)
tree35d4870b5ad719b250725b148561585dd4c9c560
parentc02db82b83da2f820531bebeba5604ac7aa4846a (diff)
downloadgo-90d43ad720a4669878bcabf14c4ea915557c0545.tar.gz
go-90d43ad720a4669878bcabf14c4ea915557c0545.zip
encoding/csv: document ReadAll behavior at EOF
Fixes #2847. R=golang-dev, bradfitz CC=golang-dev https://golang.org/cl/5641050
-rw-r--r--src/pkg/encoding/csv/reader.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/pkg/encoding/csv/reader.go b/src/pkg/encoding/csv/reader.go
index ae0f567b9d..9aa398e58b 100644
--- a/src/pkg/encoding/csv/reader.go
+++ b/src/pkg/encoding/csv/reader.go
@@ -156,6 +156,9 @@ func (r *Reader) Read() (record []string, err error) {
// ReadAll reads all the remaining records from r.
// Each record is a slice of fields.
+// A successful call returns err == nil, not err == EOF. Because ReadAll is
+// defined to read until EOF, it does not treat end of file as an error to be
+// reported.
func (r *Reader) ReadAll() (records [][]string, err error) {
for {
record, err := r.Read()