]> Cypherpunks repositories - gostls13.git/commit
cmd/covdata: format package comment for 'go doc' rendering
authorBryan C. Mills <bcmills@google.com>
Thu, 13 Jul 2023 21:30:34 +0000 (17:30 -0400)
committerGopher Robot <gobot@golang.org>
Fri, 14 Jul 2023 12:49:10 +0000 (12:49 +0000)
commitc30faf9c54a764b78db003de262517f0c7359ed2
treeccdedb761f20323aae9bedd7814f5abff8c66d61
parent089e37a931d30d4055c7468facb602c4cfa9b537
cmd/covdata: format package comment for 'go doc' rendering

Due to an errant newline, both 'go doc' and pkg.go.dev currently
interpret the long comment in cmd/covdata/doc.go as a file comment
instead of package documentation.

Removing the errant newline caused 'go doc' to render the comment, but
it does not strip out the interior '//' tokens from the '/* … */'
block.

Removing those tokens and fixing up indentation seems to give
satisfactory rendering.

Change-Id: I5757c649e7380b026f7d8d1b6fd3cb6dddfb27ad
Reviewed-on: https://go-review.googlesource.com/c/go/+/509635
Reviewed-by: Than McIntosh <thanm@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Bryan Mills <bcmills@google.com>
Auto-Submit: Bryan Mills <bcmills@google.com>
src/cmd/covdata/doc.go