1
0
mirror of https://github.com/golang/go synced 2024-09-25 09:10:14 -06:00

io: simplify documentation for ByteReader

Let C be whether c valid
Let E be whether err is non-nil

The old comment explicitly says that (~C → E). However, that does call
into question whether (E → ~C), which causes doubts for users.
Without a comment at all, it is obvious that only (E ↔ ~C) makes sense.

Fixes #11308

Change-Id: I5a7d51ceb509057eccca91f57a7e48c9d1c6d112
Reviewed-on: https://go-review.googlesource.com/15256
Reviewed-by: Andrew Gerrand <adg@golang.org>
This commit is contained in:
Joe Tsai 2015-10-01 15:21:40 -07:00 committed by Andrew Gerrand
parent dbc7203d22
commit b986e478d4

View File

@ -225,7 +225,6 @@ type WriterAt interface {
// ByteReader is the interface that wraps the ReadByte method.
//
// ReadByte reads and returns the next byte from the input.
// If no byte is available, err will be set.
type ByteReader interface {
ReadByte() (c byte, err error)
}