diff options
| author | Brad Fitzpatrick <bradfitz@golang.org> | 2013-04-19 12:00:40 -0700 |
|---|---|---|
| committer | Brad Fitzpatrick <bradfitz@golang.org> | 2013-04-19 12:00:40 -0700 |
| commit | 10cdb92000de7d6b5489f33e12e4533fdbb3f69c (patch) | |
| tree | 79f6e3dd8c32fbd2889ee545fa5b965830862d79 /doc/articles | |
| parent | 0c2b980c49649635d502d9dd98f277f8480fbada (diff) | |
| download | go-10cdb92000de7d6b5489f33e12e4533fdbb3f69c.tar.xz | |
doc: fix another broken link
Fixes #5316
R=golang-dev, r, minux.ma
CC=golang-dev
https://golang.org/cl/8871043
Diffstat (limited to 'doc/articles')
| -rw-r--r-- | doc/articles/godoc_documenting_go_code.html | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html index 96ae7451d0..3f4e3228c7 100644 --- a/doc/articles/godoc_documenting_go_code.html +++ b/doc/articles/godoc_documenting_go_code.html @@ -83,11 +83,14 @@ 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> |