Repository navigation
strings: documentation refers to non-existent function SplitFunc #75462
Description
Go version
go version 1.25.1
Output of go env in your module/workspace:
N/AWhat did you do?
I noticed in the function documentation for strings.FieldsFunc it refers to SplitFunc when describing the behaviour of the function. https://pkg.go.dev/strings#FieldsFunc
What did you see happen?
This function does not exist in this package, there is a type https://pkg.go.dev/bufio#SplitFunc, however I do not think this makes sense in the context.
This seems to be an oversight as it is mirroring the documentation of the Fields function, which correctly refers to the behaviour of Split.
What did you expect to see?
For symmetry with the Fields* functions in the strings package, I'd expect to see a SplitFunc, SplitFuncSeq, SplitNFunc, SplitNFuncSeq, SplitAfterFunc, SplitAfterFuncSeq, SplitAfterNFunc, SplitAfterNFuncSeq
Activity
tobyb121 commentedon Sep 14, 2025
Thinking a bit more about this,
Funcvariants ofSplitwould behave differently fromSplit, as they apply per-rune rather than on a separator string, so it probably makes sense to just fix the documentation here.gabyhelp commentedon Sep 14, 2025
Related Issues
(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)
seankhliao commentedon Sep 14, 2025
ah yes it should refer to just split
gopherbot commentedon Sep 14, 2025
Change https://go.dev/cl/703675 mentions this issue:
bytes,strings: remove reference to non-existent SplitFuncTapirLiu commentedon Sep 14, 2025
The doc build process should detect such broken links automatically.
bytes,strings: remove reference to non-existent SplitFunc