diff options
| author | Matthew Dempsky <mdempsky@google.com> | 2013-10-22 11:10:10 +0400 |
|---|---|---|
| committer | Andrew Gerrand <adg@golang.org> | 2013-10-22 11:10:10 +0400 |
| commit | 88eb9799109ea8009377f18e86be137ec64b3ac4 (patch) | |
| tree | 8263b492007b37a04ab77747a4f242dc7641e346 | |
| parent | 77f8cda9c08f658819c199b485cfb7f542b20adf (diff) | |
content: Remove outdated comment about "package documentation"
godoc was changed a while back to look for command documentation in
"package main" rather than "package documentation" to be consistent
with library package conventions:
https://code.google.com/p/go/source/detail?r=3633a89bb56d
R=adg
CC=golang-dev
https://golang.org/cl/15450044
| -rw-r--r-- | content/godoc-documenting-go-code.article | 2 |
1 files changed, 0 insertions, 2 deletions
diff --git a/content/godoc-documenting-go-code.article b/content/godoc-documenting-go-code.article index da8ee85..eda0860 100644 --- a/content/godoc-documenting-go-code.article +++ b/content/godoc-documenting-go-code.article @@ -37,8 +37,6 @@ Comments that are not adjacent to a top-level declaration are omitted from godoc // BUG(r): The rule Title uses for word boundaries does not handle Unicode punctuation properly. -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 [[http://golang.org/cmd/godoc/][godoc documentation]] and its corresponding [[http://golang.org/src/cmd/godoc/doc.go][doc.go]] file. - There are a few formatting rules that Godoc uses when converting comments to HTML: - Subsequent lines of text are considered part of the same paragraph; you must leave a blank line to separate paragraphs. |