summaryrefslogtreecommitdiff
path: root/doc/articles
diff options
context:
space:
mode:
authorOling Cat <olingcat@gmail.com>2012-12-04 17:40:38 +1100
committerOling Cat <olingcat@gmail.com>2012-12-04 17:40:38 +1100
commit30cf1833358aadfa238872950c4b9d5c6f6fcca3 (patch)
tree7d7ca9dc10ed08c24c0ad023ce4144edf15e2546 /doc/articles
parent778063b05ce7d2d6a1e46c78eba6a45322a81a3a (diff)
downloadgo-30cf1833358aadfa238872950c4b9d5c6f6fcca3.tar.gz
doc/articles/godoc_documenting_go_code: fix some format issues.
R=golang-dev, adg CC=golang-dev https://codereview.appspot.com/6874056 Committer: Andrew Gerrand <adg@golang.org>
Diffstat (limited to 'doc/articles')
-rwxr-xr-x[-rw-r--r--]doc/articles/godoc_documenting_go_code.html12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html
index ca66076ad..36c9b60d0 100644..100755
--- a/doc/articles/godoc_documenting_go_code.html
+++ b/doc/articles/godoc_documenting_go_code.html
@@ -65,8 +65,8 @@ package's brief description:
{{code "/src/pkg/sort/sort.go" `/Package sort provides/` `/package sort/`}}
<p>
-They can also be detailed like the <a href="/pkg/encoding/gob/">gob package</a>'s
-overview. That package uses another convention for packages
+They can also be detailed like the <a href="/pkg/encoding/gob/"><code>gob</code></a>
+package's overview. That package uses another convention for packages
that need large amounts of introductory documentation: the package comment is
placed in its own file, <a href="/src/pkg/encoding/gob/doc.go">doc.go</a>, which
contains only those comments and a package clause.
@@ -80,10 +80,10 @@ sentence will appear in godoc's <a href="/pkg/">package list</a>.
<p>
Comments that are not adjacent to a top-level declaration are omitted from
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
+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/#bugs">bytes package</a>:
+known issue from the <a href="/pkg/bytes/#bugs"><code>bytes</code></a> package:
</p>
<pre>
@@ -93,7 +93,7 @@ known issue from the <a href="/pkg/bytes/#bugs">bytes package</a>:
<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
+package "documentation". The comment on the "package documentation" clause is
used as the command's documentation. 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.