io: MultiReader
's documentation is less precise than the changelog
#53341
Labels
Documentation
Issues describing a change to documentation.
FrozenDueToAge
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
What version of Go are you using (
go version
)?Does this issue reproduce with the latest release?
Yes
What operating system and processor architecture are you using (
go env
)?go env
OutputWhat did you do?
Open the 1.19 beta 1 changelog and go to the
io
section, then read:However the https://pkg.go.dev/io#MultiReader documentation does not include that:
What did you expect to see?
A sentence including the WriterTo behaviour.
What did you see instead?
Nothing
Backstory
I didn't included a note of that while implementing
WriterTo
onMultiReader
since I thought this was implementation details (I seeWriterTo
like an implicit optional extension of allReader
interfaces) and this is the behaviour you expect (you can find a youtube video where a member of the go team do a live codding session and talks about zero copying on multireaders which was not a thing back then).If it is changelog worthy then it should be also documented in the code, so future developers can learn about it.
The text was updated successfully, but these errors were encountered: