diff options
| author | Rob Pike <r@golang.org> | 2015-05-11 13:31:05 -0700 |
|---|---|---|
| committer | Rob Pike <r@golang.org> | 2015-05-13 21:07:16 +0000 |
| commit | 1e26df40fa2ee41da971338ab25299e27a221704 (patch) | |
| tree | a1646a99492ecda11b4e86d6752cdfb991b530cd /src/cmd/doc/pkg.go | |
| parent | 6f2c0f1585e50bf2d8bcc11058373e38f5321227 (diff) | |
| download | go-1e26df40fa2ee41da971338ab25299e27a221704.tar.xz | |
cmd/doc: print BUGs after package docs
Was otherwise absent unless bound to an exported symbol,
as in the BUG with strings.Title.
Fixes #10781.
Change-Id: I1543137073a9dee9e546bc9d648ca54fc9632dde
Reviewed-on: https://go-review.googlesource.com/9899
Reviewed-by: Russ Cox <rsc@golang.org>
Diffstat (limited to 'src/cmd/doc/pkg.go')
| -rw-r--r-- | src/cmd/doc/pkg.go | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/cmd/doc/pkg.go b/src/cmd/doc/pkg.go index 3a0aa7ff89..835313e902 100644 --- a/src/cmd/doc/pkg.go +++ b/src/cmd/doc/pkg.go @@ -190,6 +190,7 @@ func (pkg *Package) packageDoc() { pkg.valueSummary(pkg.doc.Vars) pkg.funcSummary(pkg.doc.Funcs) pkg.typeSummary() + pkg.bugs() } // packageClause prints the package clause. @@ -253,6 +254,18 @@ func (pkg *Package) typeSummary() { } } +// bugs prints the BUGS information for the package. +// TODO: Provide access to TODOs and NOTEs as well (very noisy so off by default)? +func (pkg *Package) bugs() { + if pkg.doc.Notes["BUG"] == nil { + return + } + pkg.Printf("\n") + for _, note := range pkg.doc.Notes["BUG"] { + pkg.Printf("%s: %v\n", "BUG", note.Body) + } +} + // findValues finds the doc.Values that describe the symbol. func (pkg *Package) findValues(symbol string, docValues []*doc.Value) (values []*doc.Value) { for _, value := range docValues { |