From 6f42fe914169ef237423fb07e9c8321884b58c23 Mon Sep 17 00:00:00 2001
From: Sean Liao <sean@liao.dev>
Date: Tue, 3 Dec 2024 21:19:24 +0000
Subject: [PATCH] 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 <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Robert Griesemer <gri@google.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
---
 src/bufio/bufio.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/bufio/bufio.go b/src/bufio/bufio.go
index 880e52798e..160bd8adb3 100644
--- a/src/bufio/bufio.go
+++ b/src/bufio/bufio.go
@@ -29,6 +29,9 @@ var (
 // Buffered input.
 
 // Reader implements buffering for an io.Reader object.
+// A new Reader is created by calling [NewReader] or [NewReaderSize];
+// alternatively the zero value of a Reader may be used after calling [Reset]
+// on it.
 type Reader struct {
 	buf          []byte
 	rd           io.Reader // reader provided by the client
-- 
2.48.1