qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-12 02:10:21 -07:00
Code Releases Activity

go: fix help text documenting example functions

Browse Source 
R=adg, r
CC=golang-dev
https://golang.org/cl/5695062
This commit is contained in:
Robert Griesemer 2012-02-24 15:42:25 -08:00
parent e303eeb75b
commit 5c7799f108
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/cmd/go/test.go
View File

@ -167,8 +167,10 @@ A benchmark function is one named BenchmarkXXX and should have the signature,
An example function is similar to a test function but, instead of using *testing.T
to report success or failure, prints output to os.Stdout and os.Stderr.
That output is compared against the function's doc comment.
An example without a doc comment is compiled but not executed.
That output is compared against the function's "Output:" comment, which
must be the last comment in the function body (see example below). An
example with no such comment, or with no text after "Output:" is compiled
but not executed.
Godoc displays the body of ExampleXXX to demonstrate the use
of the function, constant, or variable XXX. An example of a method M with
@ -179,8 +181,9 @@ where xxx is a suffix not beginning with an upper case letter.
Here is an example of an example:
func ExamplePrintln() {
Println("The output of this example function.")
// Output: The output of this example function.
Println("The output of\nthis example.")
// Output: The output of
// this example.
}
The entire test file is presented as the example when it contains a single