]> Cypherpunks repositories - gostls13.git/commitdiff
doc: Mention godoc's handling of example functions.
authorMatthew Dempsky <mdempsky@google.com>
Wed, 9 Jan 2013 15:31:25 +0000 (07:31 -0800)
committerIan Lance Taylor <iant@golang.org>
Wed, 9 Jan 2013 15:31:25 +0000 (07:31 -0800)
Fixes #4625.

R=iant, adg
CC=golang-dev
https://golang.org/cl/7064052

doc/articles/godoc_documenting_go_code.html

index 7bcca5ad41aa42e1d83d8dd020277631c990f9f2..18a3ee9532894dc2055752fe0f113d3af6afc81e 100644 (file)
@@ -137,3 +137,9 @@ indexing via the <code>-path</code> flag or just by running <code>"godoc ."</cod
 in the source directory. See the <a href="/cmd/godoc/">godoc documentation</a>
 for more details.
 </p>
+
+<p>
+Godoc recognizes example functions written according to the
+<a href="/pkg/testing/#pkg-overview"><code>testing</code></a> package's naming
+conventions and presents them appropriately.
+</p>