bufio: SplitFunc documentation does not document ErrFinalToken #44261
Labels
Documentation
FrozenDueToAge
help wanted
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
Comments
seankhliao
changed the title
ianlancetaylor
added
help wanted
NeedsFix
|
Suppose all that needs to be done here is to mention ErrFinalToken in the documentation for SplitFunc. I can do that if that is the case @ianlancetaylor |
|
Yes, most likely one additional sentence would be appropriate in the docs for SplitFunc. Thanks. |
|
Change https://golang.org/cl/293289 mentions this issue: |
nerdatmath
added a commit
to nerdatmath/go
that referenced
this issue
Apr 29, 2021
A custom split function may return ErrFinalToken to trigger special processing. This is documented in the package documentation but not in that of SplitFunc itself. This short mention of it will hopefully reduce confusion. Fixes golang#44261
This was referenced Apr 29, 2021
|
Change https://golang.org/cl/314969 mentions this issue: |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
What did you do?
I went to https://golang.org/pkg/bufio/#SplitFunc and read the documentation to implement a
SplitFunc. In my implementation of aSplitFunc, for the case of atEOF, I simply returnedlen(data), data, nilthinking theScannerwould stop calling my function. It didn't (I was gettingpanic: bufio.Scan: too many empty tokens without progressing). I went back and looked at the "EmptyFinalToken" example here. It refered toErrFinalTokenwhich I was surprised to see since it wasn't mentioned in theSplitFuncdocumentation.What did you expect to see?
I'd expect the
SplitFuncdocumentation to include a reference toErrFinalToken.What did you see instead?
No reference to it at all.
The text was updated successfully, but these errors were encountered: