bufio: SplitFunc documentation does not document ErrFinalToken

[JensRantil]

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 a SplitFunc, for the case of atEOF, I simply returned len(data), data, nil thinking the Scanner would stop calling my function. It didn't (I was getting panic: bufio.Scan: too many empty tokens without progressing). I went back and looked at the "EmptyFinalToken" example here. It refered to ErrFinalToken which I was surprised to see since it wasn't mentioned in the SplitFunc documentation.

What did you expect to see?

I'd expect the SplitFunc documentation to include a reference to ErrFinalToken.

What did you see instead?

No reference to it at all.

[adesokanayo]

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

[ianlancetaylor]

Yes, most likely one additional sentence would be appropriate in the docs for SplitFunc. Thanks.

[gopherbot]

Change https://golang.org/cl/293289 mentions this issue: bufio: update SplitFunc documentation by mentioning ErrFinalToken

[gopherbot]

Change https://golang.org/cl/314969 mentions this issue: bufio: mention ErrFinalToken in SplitFunc documentation