code review 2596041: gob: break documentation into a separate doc.go file

gob: break documentation into a separate doc.go file

[r, 2010-10-20 03:31:10]

Hello adg (cc: golang-dev@googlegroups.com),

I'd like you to review this change.

[adg, 2010-10-20 03:34:40]

LGTM

http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go
File src/pkg/gob/doc.go (right):

http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go#newcode6
src/pkg/gob/doc.go:6: The gob package manages streams of gobs - binary values
exchanged between an
I wouldn't indent the whole thing; just makes it harder to read at 80 cols.

http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go#newcode180
src/pkg/gob/doc.go:180: package gob
s/gob/documentation/

[adg, 2010-10-20 03:35:09]

http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/Makefile
File src/pkg/gob/Makefile (right):

http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/Makefile#newcode11
src/pkg/gob/Makefile:11: doc.go\
Don't add doc.go to the build. Only godoc uses it.

[r2, 2010-10-20 03:38:24]

On Oct 19, 2010, at 8:34 PM, adg@golang.org wrote:

> LGTM
> 
> 
> http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go
> File src/pkg/gob/doc.go (right):
> 
> http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go#newcode6
> src/pkg/gob/doc.go:6: The gob package manages streams of gobs - binary
> values exchanged between an
> I wouldn't indent the whole thing; just makes it harder to read at 80
> cols.
> 
> http://codereview.appspot.com/2596041/diff/1/src/pkg/gob/doc.go#newcode180
> src/pkg/gob/doc.go:180: package gob
> s/gob/documentation/

we don't do that for packages, only commands to break the 'package main'
problem.

see other packages like this (fmt, html).

for consistency with those, i say stet. if we change our minds, we can fix all
of them in a separate pass.

[r, 2010-10-20 03:39:33]

*** Submitted as http://code.google.com/p/go/source/detail?r=90fba5de3bb2 ***

gob: break documentation into a separate doc.go file

R=adg, r2
CC=golang-dev
http://codereview.appspot.com/2596041

[adg, 2010-10-20 03:43:59]

On 20 October 2010 14:38, Rob 'Commander' Pike <r@google.com> wrote:
> we don't do that for packages, only commands to break the 'package main'
problem.

My mistake.

[r2, 2010-10-20 03:50:47]

On Oct 19, 2010, at 8:43 PM, Andrew Gerrand wrote:

> On 20 October 2010 14:38, Rob 'Commander' Pike <r@google.com> wrote:
>> we don't do that for packages, only commands to break the 'package main'
problem.
> 
> My mistake.

not sure the status quo is right.

-rob