qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-13 17:30:24 -07:00
Code Releases Activity

go/doc: document the conditions where examples are "playable"

Browse Source 
LGTM=r
R=r
CC=golang-codereviews
https://golang.org/cl/64910043
This commit is contained in:
Andrew Gerrand 2014-02-18 15:53:22 +11:00
parent aad23e708c
commit 13d85668ac
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/pkg/go/doc/example.go
View File

@ -32,6 +32,17 @@ type Example struct {
// Examples returns the examples found in the files, sorted by Name field. // Examples returns the examples found in the files, sorted by Name field.
// The Order fields record the order in which the examples were encountered. // The Order fields record the order in which the examples were encountered.
//
// Playable Examples must be in a package whose name ends in "_test".
// An Example is "playable" (the Play field is non-nil) in either of these
// circumstances:
// - The example function is self-contained: the function references only
// identifiers from other packages (or predeclared identifiers, such as
// "int") and the test file does not include a dot import.
// - The entire test file is the example: the file contains exactly one
// example function, zero test or benchmark functions, and at least one
// top-level function, type, variable, or constant declaration other
// than the example function.
func Examples(files ...*ast.File) []*Example { func Examples(files ...*ast.File) []*Example {
var list []*Example var list []*Example
for _, file := range files { for _, file := range files {