code review 66910045: testing: improve introduction to package comment

testing: improve introduction to package comment
Fixes issue 7361.

[r, 2014-02-21 21:05:01]

Hello golang-codereviews@googlegroups.com,

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

[bradfitz, 2014-02-21 22:30:34]

LGTM



On Fri, Feb 21, 2014 at 1:05 PM, <r@golang.org> wrote:

> Reviewers: golang-codereviews,
>
> Message:
> Hello golang-codereviews@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go
>
>
> Description:
> testing: improve introduction to package comment
> Fixes issue 7361.
>
> Please review this at https://codereview.appspot.com/66910045/
>
> Affected files (+10, -2 lines):
>   M src/pkg/testing/testing.go
>
>
> Index: src/pkg/testing/testing.go
> ===================================================================
> --- a/src/pkg/testing/testing.go
> +++ b/src/pkg/testing/testing.go
> @@ -8,9 +8,17 @@
>  //     func TestXxx(*testing.T)
>  // where Xxx can be any alphanumeric string (but the first letter must
> not be in
>  // [a-z]) and serves to identify the test routine.
> -// These TestXxx routines should be declared within the package they are
> testing.
>  //
> -// Tests and benchmarks may be skipped if not applicable like this:
> +// Within these functions, use the Error, Fail or related methods to
> signal failure.
> +//
> +// To write a new test suite, create a file whose name ends _test.go that
> +// contains the TestXxx functions as described here. Put the file in the
> same
> +// package as the one being tested. The file will be excluded from regular
> +// package builds but will be included when the ``go test'' command is
> run.
> +// For more detail, run ``go help test'' and ``go help testflag''.
> +//
> +// Tests and benchmarks may be skipped if not applicable with a call to
> +// the Skip method of *T and *B:
>  //     func TestTimeConsuming(t *testing.T) {
>  //         if testing.Short() {
>  //             t.Skip("skipping test in short mode.")
>
>
> --
> You received this message because you are subscribed to the Google Groups
> "golang-codereviews" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to golang-codereviews+unsubscribe@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>

[r, 2014-02-21 22:34:30]

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

testing: improve introduction to package comment
Fixes issue 7361.

LGTM=bradfitz
R=golang-codereviews, bradfitz
CC=golang-codereviews
https://codereview.appspot.com/66910045

[gobot, 2014-02-21 22:53:01]

This CL appears to have broken the windows-386-ec2 builder.