From: Matthew Dempsky <mdempsky@google.com>
Date: Wed, 9 Jan 2013 15:31:25 +0000 (-0800)
Subject: doc: Mention godoc's handling of example functions.
X-Git-Tag: go1.1rc2~1445
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=a6e4aa3ef2f0a0132bb7294a7a662b4b96143742;p=gostls13.git

doc: Mention godoc's handling of example functions.

Fixes #4625.

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

diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html
index 7bcca5ad41..18a3ee9532 100644
--- a/doc/articles/godoc_documenting_go_code.html
+++ b/doc/articles/godoc_documenting_go_code.html
@@ -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>