code review 1404041: doc/code: example package with tests

doc/code: example package with tests

[adg, 2010-05-30 14:34:57]

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

I'd like you to review this change.

[r, 2010-05-30 16:46:44]

i think it's good but it could use a little tightening up.  i suggest collapsing
the last part to say what to do and avoid printing the results.  that has the
advantage of reducing the likelihood of the document getting out of date.

http://codereview.appspot.com/1404041/diff/2001/3001
File doc/code.html (right):

http://codereview.appspot.com/1404041/diff/2001/3001#newcode210
doc/code.html:210: <code>Double</code> which takes an int and returns that value
multiplied by 2.
s/ which/, which/
int should be <code>ed

http://codereview.appspot.com/1404041/diff/2001/3001#newcode211
doc/code.html:211: It consists of three files.
if you put a number in the introduction, you should number the entries either
directly or by saying something like First, there is ...

http://codereview.appspot.com/1404041/diff/2001/3001#newcode215
doc/code.html:215: The package implementation, <code>numbers.go</code>:
s/The/First, the

http://codereview.appspot.com/1404041/diff/2001/3001#newcode227
doc/code.html:227: The tests, <code>numbers_test.go</code>:
s/The/Next, the/

http://codereview.appspot.com/1404041/diff/2001/3001#newcode233
doc/code.html:233: import "testing"
import (
  "testing"
)

to encourage that style

http://codereview.appspot.com/1404041/diff/2001/3001#newcode249
doc/code.html:249: t.Errorf("expected %d for %d, got %d.", dt.out, dt.in, v)
it's nice in simple cases to write the failures out in terms of the original
Double(%d) returns %d; should be %d

http://codereview.appspot.com/1404041/diff/2001/3001#newcode256
doc/code.html:256: And the <code>Makefile</code>:
s/And/Finally,/

[adg, 2010-05-30 17:10:22]

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

Please take another look.

[r, 2010-05-30 17:20:09]

LGTM

[adg, 2010-05-30 17:22:04]

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

doc/code: example package with tests

R=r
CC=golang-dev
http://codereview.appspot.com/1404041

[rsc1, 2010-05-31 17:44:49]

http://codereview.appspot.com/1404041/diff/13001/14001
File doc/code.html (right):

http://codereview.appspot.com/1404041/diff/13001/14001#newcode251
doc/code.html:251: t.Errorf("Double(%d) returns %d; should be %d.", dt.in, v,
dt.out)
The conventional form of this print is

t.Errorf("Double(%d) = %d, want %d", dt.in, v, dt.out)