cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 23:53:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bufio: mention ErrFinalToken in SplitFunc documentation

Browse Source 
It is documented elsewhere in the package documentation but this additional
mention of it will hopefully reduce confusion.

Fixes #44261

Change-Id: I4e9d8f4564ebb7fbe047c92ee2cdffedb39f2a31
GitHub-Last-Rev: 64b6421503dfb9396e46f94f9805ff7f8bf2b31b
GitHub-Pull-Request: golang/go#45839
Reviewed-on: https://go-review.googlesource.com/c/go/+/314969
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Matt Harden 2021-04-30 01:34:44 +00:00 committed by Ian Lance Taylor
parent c23a32284a
commit 93200b98c7
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/bufio/scan.go
View File

@ -48,7 +48,8 @@ type Scanner struct {
// and the next token to return to the user, if any, plus an error, if any. // and the next token to return to the user, if any, plus an error, if any.
// //
// Scanning stops if the function returns an error, in which case some of // Scanning stops if the function returns an error, in which case some of
// the input may be discarded. // the input may be discarded. If that error is ErrFinalToken, scanning
// stops with no error.
// //
// Otherwise, the Scanner advances the input. If the token is not nil, // Otherwise, the Scanner advances the input. If the token is not nil,
// the Scanner returns it to the user. If the token is nil, the // the Scanner returns it to the user. If the token is nil, the