]> Cypherpunks repositories - gostls13.git/commitdiff
doc/articles: update reference to obsolete "package documentation".
authorDavid Symonds <dsymonds@golang.org>
Tue, 26 Mar 2013 02:01:24 +0000 (13:01 +1100)
committerDavid Symonds <dsymonds@golang.org>
Tue, 26 Mar 2013 02:01:24 +0000 (13:01 +1100)
R=golang-dev, r
CC=golang-dev
https://golang.org/cl/7475048

doc/articles/godoc_documenting_go_code.html

index 18a3ee9532894dc2055752fe0f113d3af6afc81e..96ae7451d07011c183a5fb6373f45c4a7f387554 100644 (file)
@@ -91,10 +91,9 @@ known issue from the <a href="/pkg/bytes/#pkg-bugs"><code>bytes</code></a> packa
 </pre>
 
 <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
-used as the command's documentation. For example, see the
+Godoc treats executable commands in the same way. It looks for a comment on
+package main, which is sometimes put in a separate file called <code>doc.go</code>.
+For example, see the
 <a href="/cmd/godoc/">godoc documentation</a> and its corresponding
 <a href="/src/cmd/godoc/doc.go">doc.go</a> file.
 </p>