FAQ
Reviewers: iant,

Message:
Hello iant@golang.org (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go


Description:
doc: Mention godoc's handling of example functions.

Please review this at https://codereview.appspot.com/7064052/

Affected files:
M doc/articles/godoc_documenting_go_code.html


Index: doc/articles/godoc_documenting_go_code.html
===================================================================
--- a/doc/articles/godoc_documenting_go_code.html
+++ b/doc/articles/godoc_documenting_go_code.html
@@ -91,6 +91,12 @@
</pre>

<p>
+Godoc recognizes example functions written according to the
+<a href="/pkg/testing/#pkg-overview"><code>testing</code></a> package's
naming
+conventions and tries to present them appropriately.
+</p>
+
+<p>
Godoc treats executable commands somewhat differently. Instead of
inspecting the
command source code, it looks for a Go source file belonging to the special
package "documentation". The comment on the "package documentation" clause
is

Search Discussions

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupgolang-dev @
categoriesgo
postedJan 7, '13 at 7:13p
activeJan 7, '13 at 7:13p
posts1
users1
websitegolang.org

1 user in discussion

Mdempsky: 1 post

People

Translate

site design / logo © 2022 Grokbase