From: Joe Tsai <joetsai@digital-static.net>
Date: Thu, 1 Oct 2015 22:21:40 +0000 (-0700)
Subject: io: simplify documentation for ByteReader
X-Git-Tag: go1.6beta1~905
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=b986e478d4cf97d36418a22821582aae81460cf7;p=gostls13.git

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

diff --git a/src/io/io.go b/src/io/io.go
index 5a8889363a..8e7855c665 100644
--- a/src/io/io.go
+++ b/src/io/io.go
@@ -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)
 }