diff options
| author | David Symonds <dsymonds@golang.org> | 2013-03-26 13:01:24 +1100 |
|---|---|---|
| committer | David Symonds <dsymonds@golang.org> | 2013-03-26 13:01:24 +1100 |
| commit | b30900b6737b5ac27234128864f73532bd42e2e0 (patch) | |
| tree | 4e23e5a79477e77420fc90fa0dfa02927f8012ab /doc/articles | |
| parent | 2bdafc50a4bb50a471a335ccfc43ac738873adab (diff) | |
| download | go-b30900b6737b5ac27234128864f73532bd42e2e0.tar.gz | |
doc/articles: update reference to obsolete "package documentation".
R=golang-dev, r
CC=golang-dev
https://codereview.appspot.com/7475048
Diffstat (limited to 'doc/articles')
| -rw-r--r-- | doc/articles/godoc_documenting_go_code.html | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html index 18a3ee953..96ae7451d 100644 --- a/doc/articles/godoc_documenting_go_code.html +++ b/doc/articles/godoc_documenting_go_code.html @@ -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> |