-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Edit type/func documentation in the consumer package #3269
Edit type/func documentation in the consumer package #3269
Conversation
This fix makes the pdata folder consistent in documenting the String methods.
This issue was causing many example snippets to show up incorrectly on the godoc
- Fixed wrong description of NewErr - Added doc for Capabilities method
Changing here will ensure that the changes to consumer/pdata/generated_* files will persist after running `go run cmd/pdatagen/main.go`.
Tests failed:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please for me split this into 2 PRs:
- cmd/pdatagen and consumer/pdata
- Rest of the files
This will help me a lot for review.
Thanks @bogdandrutu for the suggestion; I have updated this PR to not contain any of the cmd/pdatagen/internal or consumer/pdata/generated*.go files! Those files will be handled in the PR #3361 . Thanks again 😄 |
consumer/pdata/metric.go
Outdated
// Metrics is an opaque interface that allows transition to the new internal Metrics data, but also facilitate the | ||
// transition to the new components especially for traces. | ||
// Metrics is an opaque interface that allows transition to the new internal Metrics data, but also facilitates the | ||
// transition to the new components, especially for traces. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reference to "traces" is confusing here. @bogdandrutu do you know what this is supposed to mean?
Please resolve the conflicts. |
For func defined in consumer/consumertest/err.go Co-authored-by: Tigran Najaryan <[email protected]>
Renamed "message" to "string"
@bogdandrutu can you please review and this PR can then be merged if all is done. |
Description:
This PR updates the documentation of type and func declarations in the consumer package and all of its subpackages, with a focus on correcting grammar/spelling mistakes, cleaning up syntax to render the examples better, and updating incorrect references or wording. Note that this does not
Link to tracking Issue:
Addresses part of issue #3050.
Related to #3361
Documentation: