Edit type/func documentation in the consumer package#3269
Merged
bogdandrutu merged 31 commits intoopen-telemetry:mainfrom Jun 14, 2021
Merged
Edit type/func documentation in the consumer package#3269bogdandrutu merged 31 commits intoopen-telemetry:mainfrom
bogdandrutu merged 31 commits intoopen-telemetry:mainfrom
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
bogdandrutu
reviewed
May 24, 2021
Changing here will ensure that the changes to consumer/pdata/generated_* files will persist after running `go run cmd/pdatagen/main.go`.
Member
|
Tests failed: |
6 tasks
bogdandrutu
reviewed
Jun 2, 2021
Member
bogdandrutu
left a comment
There was a problem hiding this comment.
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.
1 task
Contributor
Author
|
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 😄 |
tigrannajaryan
approved these changes
Jun 8, 2021
| // 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. |
Member
There was a problem hiding this comment.
The reference to "traces" is confusing here. @bogdandrutu do you know what this is supposed to mean?
Member
|
Please resolve the conflicts. |
For func defined in consumer/consumertest/err.go Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Renamed "message" to "string"
Member
|
@bogdandrutu can you please review and this PR can then be merged if all is done. |
bogdandrutu
approved these changes
Jun 14, 2021
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
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.
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: