Commit b986e478 authored by Joe Tsai's avatar Joe Tsai Committed by Andrew Gerrand

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/15256Reviewed-by: 's avatarAndrew Gerrand <adg@golang.org>
parent dbc7203d
......@@ -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)
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment