From c2f9be10d4cf9b82b6fdeb23849a909a9923f6aa Mon Sep 17 00:00:00 2001 From: Oling Cat Date: Tue, 4 Dec 2012 17:40:38 +1100 Subject: [PATCH] doc/articles/godoc_documenting_go_code: fix some format issues. R=golang-dev, adg CC=golang-dev https://golang.org/cl/6874056 --- doc/articles/godoc_documenting_go_code.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) mode change 100644 => 100755 doc/articles/godoc_documenting_go_code.html diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html old mode 100644 new mode 100755 index ca66076ad7..36c9b60d05 --- 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/`}}

-They can also be detailed like the gob package's -overview. That package uses another convention for packages +They can also be detailed like the gob +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, doc.go, which contains only those comments and a package clause. @@ -80,10 +80,10 @@ sentence will appear in godoc's package list.

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 "BUG(who)” are recognized as known bugs, and included in -the "Bugs” section of the package documentation. The "who” part should be the +the word "BUG(who)" 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 bytes package: +known issue from the bytes package:

@@ -93,7 +93,7 @@ known issue from the bytes package:
 

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 godoc documentation and its corresponding doc.go file. -- 2.48.1