diff options
Diffstat (limited to 'doc/articles/godoc_documenting_go_code.html')
| -rw-r--r-- | doc/articles/godoc_documenting_go_code.html | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html index 18a3ee953..3f4e3228c 100644 --- a/doc/articles/godoc_documenting_go_code.html +++ b/doc/articles/godoc_documenting_go_code.html @@ -83,18 +83,20 @@ godoc's output, with one notable exception. Top-level comments that begin with the word <code>"BUG(who)"</code> are recognized as known bugs, and included in the "Bugs" section of the package documentation. The "who" part should be the user name of someone who could provide more information. For example, this is a -known issue from the <a href="/pkg/bytes/#pkg-bugs"><code>bytes</code></a> package: +known issue from the <a href="/pkg/sync/atomic/#pkg-note-BUG"><code>sync/atomic</code></a> package: </p> <pre> -// BUG(r): The rule Title uses for word boundaries does not handle Unicode punctuation properly. +// BUG(rsc): On x86-32, the 64-bit functions use instructions +// unavailable before the Pentium MMX. On both ARM and x86-32, it is the +// caller's responsibility to arrange for 64-bit alignment of 64-bit +// words accessed atomically. </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> |