updating Size() doc

djherbis · Mar 3, 2017 · 26b9a1f · 26b9a1f
1 parent d01224c
commit 26b9a1f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/reader.go b/reader.go
@@ -74,8 +74,8 @@ func (r *Reader) Close() error {
 	return r.file.Close()
 }
 
-// Size returns the current size of this stream, and true if the
-// the stream writer has been closed. If closed, the size will no longer change.
+// Size returns the current size of the entire stream (not the remaining bytes to be read),
+// and true iff the the stream writer has been closed. If closed, the size will no longer change.
 // Can be safely called concurrently with all other methods.
 func (r *Reader) Size() (int64, bool) {
 	return r.s.b.Size()