diff options
| author | Katrina Owen <katrina.owen@gmail.com> | 2015-10-13 16:42:20 -0600 |
|---|---|---|
| committer | Andrew Gerrand <adg@golang.org> | 2015-10-14 00:46:21 +0000 |
| commit | a6f69b31e0bdc625e1e026d8df6fc1f7c604067a (patch) | |
| tree | 40beadac66729505aa3b81120e77d226b5df427c /src/encoding/csv | |
| parent | 30b966307f475b1445816308f8cb2c5813b38232 (diff) | |
| download | go-a6f69b31e0bdc625e1e026d8df6fc1f7c604067a.tar.gz go-a6f69b31e0bdc625e1e026d8df6fc1f7c604067a.zip | |
encoding/csv: indicate package of EOF in docs
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>
Diffstat (limited to 'src/encoding/csv')
| -rw-r--r-- | src/encoding/csv/reader.go | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/encoding/csv/reader.go b/src/encoding/csv/reader.go index 37bf80ceae..a6bb780bf2 100644 --- a/src/encoding/csv/reader.go +++ b/src/encoding/csv/reader.go @@ -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) { |