code review 7090044: testing: document whitespace trimming of example expect...

testing: document whitespace trimming of example expected/actual output.

Fixes issue 4642.

[cespare, 2013-01-11 07:46:46]

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

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

[adg, 2013-01-11 11:46:37]

https://codereview.appspot.com/7090044/diff/3002/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

https://codereview.appspot.com/7090044/diff/3002/src/pkg/testing/testing.go#n...
src/pkg/testing/testing.go:45: // the standard output of the function when the
tests are run. Leading and trailing
Perhaps just add this parenthetical:

(The comparison ignores leading and trailing space.)

[cespare, 2013-01-11 15:34:49]

PTAL

https://codereview.appspot.com/7090044/diff/3002/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

https://codereview.appspot.com/7090044/diff/3002/src/pkg/testing/testing.go#n...
src/pkg/testing/testing.go:45: // the standard output of the function when the
tests are run. Leading and trailing
Ah, much more concise.

On 2013/01/11 11:46:37, adg wrote:
> Perhaps just add this parenthetical:
> 
> (The comparison ignores leading and trailing space.)

[adg, 2013-01-12 00:01:37]

https://codereview.appspot.com/7090044/diff/10001/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

https://codereview.appspot.com/7090044/diff/10001/src/pkg/testing/testing.go#...
src/pkg/testing/testing.go:45: // the standard output of the function when the
tests are run (ignoring leading
I know I'm being picky, but I think it's hard to grok what the ignoring is
about. I think the parenthetical should be a separate sentence. It's always
better to use small, distinct, unambiguous sentences.

[cespare, 2013-01-12 00:13:16]

PTAL

https://codereview.appspot.com/7090044/diff/10001/src/pkg/testing/testing.go
File src/pkg/testing/testing.go (right):

https://codereview.appspot.com/7090044/diff/10001/src/pkg/testing/testing.go#...
src/pkg/testing/testing.go:45: // the standard output of the function when the
tests are run (ignoring leading
That's fair.

On 2013/01/12 00:01:37, adg wrote:
> I know I'm being picky, but I think it's hard to grok what the ignoring is
> about. I think the parenthetical should be a separate sentence. It's always
> better to use small, distinct, unambiguous sentences.

[adg, 2013-01-12 00:17:39]

LGTM

[adg, 2013-01-12 00:18:34]

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

      testing: document whitespace trimming of example expected/actual output.

Fixes issue 4642.

R=golang-dev, adg
CC=golang-dev
https://codereview.appspot.com/7090044

Committer: Andrew Gerrand <adg@golang.org>