Skip to content

Commit 6f42fe9

Browse files
seankhliaoRobert Griesemer
authored and
Robert Griesemer
committed
bufio: document Reader must be created with New functions
Fixes #37347 Change-Id: Id642dbe7e52933f8d6cf7116c3c27ddb74efba9d Reviewed-on: https://go-review.googlesource.com/c/go/+/633315 LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Robert Griesemer <[email protected]> Reviewed-by: Michael Knyszek <[email protected]>
1 parent d241ea8 commit 6f42fe9

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/bufio/bufio.go

+3
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ var (
2929
// Buffered input.
3030

3131
// Reader implements buffering for an io.Reader object.
32+
// A new Reader is created by calling [NewReader] or [NewReaderSize];
33+
// alternatively the zero value of a Reader may be used after calling [Reset]
34+
// on it.
3235
type Reader struct {
3336
buf []byte
3437
rd io.Reader // reader provided by the client

0 commit comments

Comments
 (0)