code review 7000051: encoding/gob: document that structs only encode/decode ...

encoding/gob: document that structs only encode/decode exported fields

Fixes issue 4579.

[rsc, 2012-12-22 15:32:21]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go/

[minux1, 2012-12-22 15:36:59]

LGTM.

I think this is common to encoding/* packages, should
we write about this in src/pkg/encoding/doc.go to give
the user a higher level view of all encoding packages?

[rsc, 2012-12-22 15:43:31]

I don't think so. That will make it look like there is a package named
encoding, and there isn't.
Also, not all encoding packages deal with structs: xml, json, and gob do,
but base32, base64, hex, csv, and others do not.
I did check that json mentions that only exported field names are
considered.

Russ

[rsc, 2012-12-22 15:43:52]

*** Submitted as https://code.google.com/p/go/source/detail?r=535511012f51 ***

encoding/gob: document that structs only encode/decode exported fields

Fixes issue 4579.

R=golang-dev, minux.ma
CC=golang-dev
https://codereview.appspot.com/7000051