Skip to content
/ go Public
forked from golang/go

Latest commit

 

History

History
 
 

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
empty.go
empty.go
 
 
empty.golden
empty.golden
 
 
generic_constraints.go
generic_constraints.go
 
 
generic_constraints.golden
generic_constraints.golden
 
 
import_groups.go
import_groups.go
 
 
import_groups.golden
import_groups.golden
 
 
import_groups_named.go
import_groups_named.go
 
 
import_groups_named.golden
import_groups_named.golden
 
 
inspect_signature.go
inspect_signature.go
 
 
inspect_signature.golden
inspect_signature.golden
 
 
iota.go
iota.go
 
 
iota.golden
iota.golden
 
 
issue43658.go
issue43658.go
 
 
issue43658.golden
issue43658.golden
 
 
multiple.go
multiple.go
 
 
multiple.golden
multiple.golden
 
 
shadow_predeclared.go
shadow_predeclared.go
 
 
shadow_predeclared.golden
shadow_predeclared.golden
 
 
values.go
values.go
 
 
values.golden
values.golden
 
 
whole_file.go
whole_file.go
 
 
whole_file.golden
whole_file.golden
 
 
whole_function.go
whole_function.go
 
 
whole_function.golden
whole_function.golden
 
 
whole_function_external.go
whole_function_external.go
 
 
whole_function_external.golden
whole_function_external.golden
 
 

README.md

These files are processed by example_test.go:TestExamples.

A .golden file is a txtar file with two sections for each example that should be created by doc.Examples from the corresponding .go file.

One section, named EXAMPLE_NAME.Output, contains the example's output, the value of the field Example.Output.

The other, named EXAMPLE_NAME.Play, contains the formatted code for a playable version of the example, the value of the field Example.Play.

If a section is missing, it is treated as being empty.