]> Cypherpunks repositories - gostls13.git/commitdiff
encoding/csv: indicate package of EOF in docs
authorKatrina Owen <katrina.owen@gmail.com>
Tue, 13 Oct 2015 22:42:20 +0000 (16:42 -0600)
committerAndrew Gerrand <adg@golang.org>
Wed, 14 Oct 2015 00:46:21 +0000 (00:46 +0000)
The documentation listing err == EOF can be confusing to newcomers
to the language who are looking for the relevant documentation for
that error.

Change-Id: I301885950d0e1d0fbdf3a1892fca86eac7a0c616
Reviewed-on: https://go-review.googlesource.com/15806
Reviewed-by: Andrew Gerrand <adg@golang.org>
src/encoding/csv/reader.go

index 37bf80ceaedd9b8e7e69fe5a3d852a5d5b6dd787..a6bb780bf28a0b76de6fd02e323665d1db8cd5fc 100644 (file)
@@ -155,7 +155,7 @@ 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
+// A successful call returns err == nil, not err == io.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) {