encoding/gob: document that Decode returns io.EOF at end of input

[gopherbot]

by kkowalczyk:

Docs for gob.Decoder.Decode() should mention that io.EOF is returned when there's
nothing more to decode. One of the examples could be extended to show how to handle that
properly. Due to lack of this information, I had to write a test program to understand
the behavior.

[robpike]

Comment 1:

I'm surprised you find "EOF at end of input" surprising. Can you please explain better
what confused you?

[gopherbot]

Comment 2 by kkowalczyk:

I don't find it surprising. If you feel like being condescending, then at least be
factually correct wrt what I wrote.
The behavior is perfectly logical once you know it but when I didn't know it, it wasn't
obvious. Obviously.
I don't have an explanation for my confusion. I know that I did experience it.
Maybe I'm dumb.
Or maybe you can't expect people to make mental connections between an EOF constant in
io package and error returned from Decode(). Documentation is not meant to be a puzzle.

[rsc]

Comment 3:

FWIW, I agree that it's nice to be explicit about what can be expected. It's not that
"EOF at end of input" is surprising, it's that unless that fact is documented, you might
not want to rely on it.

Labels changed: added release-go1.3maybe.

Owner changed to @robpike.

Status changed to Accepted.

[robpike]

Comment 4:

This issue was closed by revision 22c668a.

Status changed to Fixed.