Commit c2f9be10 authored by Oling Cat's avatar Oling Cat Committed by Andrew Gerrand

doc/articles/godoc_documenting_go_code: fix some format issues.

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/6874056
parent 0420eb3b
......@@ -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.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment