qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-26 15:46:54 -07:00
Code Releases Activity

cmd/godoc: document package-level examples

Browse Source 
Fixes  issue  5807 .

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/23940043
This commit is contained in:
Olivier Duperray 2013-11-11 12:09:24 +11:00 committed by Andrew Gerrand
parent 597b9c0d19
commit 8f10c76471
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/pkg/testing/testing.go
View File

@ -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() { ... }