code review 7134056: doc/effective_go.html: add a section about the blank id...

doc/effective_go.html: add a section about the blank identifier

[rsc, 2013-01-18 17:40:54]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[minux1, 2013-01-18 18:06:08]

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html
File doc/effective_go.html (right):

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3022: Unused imports bloat a program unnecessarily;
and lengthen the compilation time.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3056: the <code><a
href="/pkg/net/http/pprof">net/http/pprof</a></code>
href="/pkg/net/http/pprof/"
to save a redirect.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3099: If a type—for example, <code><a
href="/pkg/encoding/json/#RawMessage">json.RawMessage</a></code>
s/-/\&mdash;/
perhaps, s/$/\&mdash;/

[minux1, 2013-01-18 18:08:09]

perhaps also verify that doc/progs/unused2.go
actually compiles (just a "// compile" suffices).

[bradfitz, 2013-01-18 18:18:20]

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html
File doc/effective_go.html (right):

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3056: the <code><a
href="/pkg/net/http/pprof">net/http/pprof</a></code>
I think image/jpeg and image/gif registration of image types might be more
approachable examples.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3099: If a type—for example, <code><a
href="/pkg/encoding/json/#RawMessage">json.RawMessage</a></code>
the dash isn't being used as a colon or semicolon, since "If a type" isn't
complete, so I would expect this to be a clarifying subexpression ("for example,
X"), but there's no closing dash to return to the sentence.

I offer no suggestions and don't claim to know my only language well. It just
read unbalanced somehow.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3106: var _ Marshaler = (*RawMessage)(nil)
I would write this from the perspective of a user of the json package, not the
json package itself:

var _ json.Marshaler = (*MyMessage)(nil)

[rsc, 2013-01-18 21:28:01]

PTAL

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html
File doc/effective_go.html (right):

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3022: Unused imports bloat a program unnecessarily;
On 2013/01/18 18:06:08, minux wrote:
> and lengthen the compilation time.

Done.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3056: the <code><a
href="/pkg/net/http/pprof">net/http/pprof</a></code>
On 2013/01/18 18:18:20, bradfitz wrote:
> I think image/jpeg and image/gif registration of image types might be more
> approachable examples.

HTTP is coming up in the next section. I think it ties in okay.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3056: the <code><a
href="/pkg/net/http/pprof">net/http/pprof</a></code>
On 2013/01/18 18:06:08, minux wrote:
> href="/pkg/net/http/pprof/"
> to save a redirect.

Done.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3099: If a type—for example, <code><a
href="/pkg/encoding/json/#RawMessage">json.RawMessage</a></code>
On 2013/01/18 18:06:08, minux wrote:
> s/-/\&mdash;/
> perhaps, s/$/\&mdash;/

Done.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3099: If a type—for example, <code><a
href="/pkg/encoding/json/#RawMessage">json.RawMessage</a></code>
I was missing the ending dash.

https://codereview.appspot.com/7134056/diff/4001/doc/effective_go.html#newcod...
doc/effective_go.html:3106: var _ Marshaler = (*RawMessage)(nil)
On 2013/01/18 18:18:20, bradfitz wrote:
> I would write this from the perspective of a user of the json package, not the
> json package itself:
> 
> var _ json.Marshaler = (*MyMessage)(nil)

Done.

[minux1, 2013-01-18 21:30:40]

hg upload failed?

[rsc, 2013-01-18 21:31:58]

If you mean I failed to run hg upload, yes. :-)
Done.

[minux1, 2013-01-18 22:21:59]

On 2013/01/18 21:31:58, rsc wrote:
> If you mean I failed to run hg upload, yes. :-)
"hg upload" did fail this time though.
error: old chunk mismatch for effective_go.html
please upload again as i want to view diff between patch sets.

[rsc, 2013-01-18 22:33:13]

I tried another hg upload but the code review site is still confused. I bet it
is another Python UTF-8 string problem. It looks like you'll need to do the
multi-version diff by hand, sorry.

[minux1, 2013-01-18 22:40:55]

LGTM. please wait for others.

[adg, 2013-01-21 05:04:18]

LGTM

[rsc, 2013-01-22 19:00:16]

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

doc/effective_go.html: add a section about the blank identifier

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