diff options
author | Andrew Gerrand <adg@golang.org> | 2013-11-13 14:35:59 +1100 |
---|---|---|
committer | Andrew Gerrand <adg@golang.org> | 2013-11-13 14:35:59 +1100 |
commit | 021476db3bccf19c84344b60e95bec67c21bc155 (patch) | |
tree | d81fd612f2adf127fdc57273af71adc0129e93bf | |
parent | 1c961995ae410fd706f84d3e1d3f0f6919d5f596 (diff) | |
download | go-021476db3bccf19c84344b60e95bec67c21bc155.tar.gz go-021476db3bccf19c84344b60e95bec67c21bc155.zip |
[release-branch.go1.2] cmd/godoc: document package-level examples
««« CL 23940043 / 6ad0ec54cf2d
cmd/godoc: document package-level examples
Fixes issue 5807 .
R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/23940043
»»»
R=golang-dev
CC=golang-dev
https://golang.org/cl/25500045
-rw-r--r-- | src/pkg/testing/testing.go | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/pkg/testing/testing.go b/src/pkg/testing/testing.go index 5019e07626..52dc166dd9 100644 --- a/src/pkg/testing/testing.go +++ b/src/pkg/testing/testing.go @@ -73,17 +73,19 @@ // // Example functions without output comments are compiled but not executed. // -// The naming convention to declare examples for a function F, a type T and +// The naming convention to declare examples for the package, a function F, a type T and // method M on type T are: // +// func Example() { ... } // func ExampleF() { ... } // func ExampleT() { ... } // func ExampleT_M() { ... } // -// Multiple example functions for a type/function/method may be provided by +// Multiple example functions for a package/type/function/method may be provided by // appending a distinct suffix to the name. The suffix must start with a // lower-case letter. // +// func Example_suffix() { ... } // func ExampleF_suffix() { ... } // func ExampleT_suffix() { ... } // func ExampleT_M_suffix() { ... } |