bufio: clarify the maximum token size

Fixes #43183.

Change-Id: I50d99ef8ed513bba47166a25ea5c7c80cd8bd799
GitHub-Last-Rev: 684d70e9a3dbc0ce280e1112105d666cd5754e9f
GitHub-Pull-Request: golang/go#61979
Reviewed-on: https://go-review.googlesource.com/c/go/+/518860
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: Ian Lance Taylor <iant@google.com>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>

diff --git a/src/bufio/scan.go b/src/bufio/scan.go
index e247cbcf32f55c631be2f6a634e7c3acfc0cc418..5c2782f43888315cf465bc431fc9d5b3be45760e 100644 (file)
--- a/src/bufio/scan.go
+++ b/src/bufio/scan.go
@@ -255,10 +255,10 @@ func (s *Scanner) setErr(err error) {
        }
 }
 
-// Buffer sets the initial buffer to use when scanning and the maximum
-// size of buffer that may be allocated during scanning. The maximum
-// token size is the larger of max and cap(buf). If max <= cap(buf),
-// Scan will use this buffer only and do no allocation.
+// Buffer sets the initial buffer to use when scanning
+// and the maximum size of buffer that may be allocated during scanning.
+// The maximum token size must be less than the larger of max and cap(buf).
+// If max <= cap(buf), Scan will use this buffer only and do no allocation.
 //
 // By default, Scan uses an internal buffer and sets the
 // maximum token size to MaxScanTokenSize.