Commit021476d

committed

[release-branch.go1.2] cmd/godoc: document package-level examples

««« CL 23940043 / 6ad0ec54cf2dcmd/godoc: document package-level examplesFixes issue 5807 .R=golang-dev, adgCC=golang-devhttps://golang.org/cl/23940043»»»R=golang-devCC=golang-devhttps://golang.org/cl/25500045

1 parent1c96199 commit021476dCopy full SHA for 021476d

File tree

-2

lines changed

-2

lines changed

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -73,17 +73,19 @@`
`73`	`73`	`//`
`74`	`74`	`// Example functions without output comments are compiled but not executed.`
`75`	`75`	`//`
`76`		`-// The naming convention to declare examples for a function F, a type T and`
	`76`	`+// The naming convention to declare examples forthe package,a function F, a type T and`
`77`	`77`	`// method M on type T are:`
`78`	`78`	`//`
	`79`	`+// func Example() { ... }`
`79`	`80`	`// func ExampleF() { ... }`
`80`	`81`	`// func ExampleT() { ... }`
`81`	`82`	`// func ExampleT_M() { ... }`
`82`	`83`	`//`
`83`		`-// Multiple example functions for a type/function/method may be provided by`
	`84`	`+// Multiple example functions for apackage/type/function/method may be provided by`
`84`	`85`	`// appending a distinct suffix to the name. The suffix must start with a`
`85`	`86`	`// lower-case letter.`
`86`	`87`	`//`
	`88`	`+// func Example_suffix() { ... }`
`87`	`89`	`// func ExampleF_suffix() { ... }`
`88`	`90`	`// func ExampleT_suffix() { ... }`
`89`	`91`	`// func ExampleT_M_suffix() { ... }`

Comments

(0)