docs(pkg): add package-level godoc comments#233
Open
Redamency wants to merge 1 commit into
Open
Conversation
Add package documentation to four pkg/ packages that previously lacked package-level godoc comments. These are the public-facing packages of the project and benefit from a short overview shown by `go doc` and pkg.go.dev: - pkg/metric collector framework / Prometheus integration - pkg/metric/runtime process and Go runtime collector registration - pkg/tracing tracer scheduling and watch-event delivery - pkg/types shared public types and sentinel errors No code or behavior changes. Signed-off-by: Redamency <1683209437@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add package-level godoc comments to four
pkg/packages that previously had none:pkg/metric— collector framework and Prometheus integrationpkg/metric/runtime— process and Go runtime collector registrationpkg/tracing— tracer scheduling and watch-event deliverypkg/types— shared public types and sentinel errorsWhy
These are the public-facing packages of the project. A short package overview is what
go doc <pkg>and pkg.go.dev display first, so adding it improves discoverability for new contributors and external users without changing any code or behavior.Notes