diff --git a/cmd/godoc/doc.go b/cmd/godoc/doc.go index dd7f3c1a..17cf23e5 100644 --- a/cmd/godoc/doc.go +++ b/cmd/godoc/doc.go @@ -137,6 +137,8 @@ one may run godoc as follows: Godoc documentation is converted to HTML or to text using the go/doc package; see http://golang.org/pkg/go/doc/#ToHTML for the exact rules. +Godoc also shows example code that is runnable by the testing package; +see http://golang.org/pkg/testing/#hdr-Examples for the conventions. See "Godoc: documenting Go code" for how to write good comments for godoc: http://golang.org/doc/articles/godoc_documenting_go_code.html