From: Katrina Owen <katrina.owen@gmail.com>
Date: Tue, 13 Oct 2015 22:42:20 +0000 (-0600)
Subject: encoding/csv: indicate package of EOF in docs
X-Git-Tag: go1.6beta1~847
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=a6f69b31e0bdc625e1e026d8df6fc1f7c604067a;p=gostls13.git

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>
---

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) {