Skip to content
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

Update pdata godoc strings #5226

Merged
merged 1 commit into from
Apr 14, 2022

Conversation

dmitryax
Copy link
Member

  • Use copy of the godoc comments from pdata/internal instead of mentioning aliases in pdata/p public API docs.
  • Update godoc strings in both pdata/p and pdata/internal to keep them consistent.

@dmitryax dmitryax added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Apr 14, 2022
@dmitryax dmitryax requested review from a team and Aneurysm9 April 14, 2022 20:06
@dmitryax dmitryax force-pushed the update-pdata-dogoc branch from f00b7a8 to ddf7aaf Compare April 14, 2022 20:09
@codecov
Copy link

codecov bot commented Apr 14, 2022

Codecov Report

Merging #5226 (5b1009a) into main (ac9eb92) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #5226   +/-   ##
=======================================
  Coverage   90.51%   90.51%           
=======================================
  Files         186      186           
  Lines       11033    11033           
=======================================
  Hits         9987     9987           
  Misses        824      824           
  Partials      222      222           
Impacted Files Coverage Δ
pdata/internal/common.go 94.94% <ø> (ø)
pdata/internal/logs.go 97.14% <ø> (ø)
pdata/internal/metrics.go 91.89% <ø> (ø)
pdata/internal/spanid.go 100.00% <ø> (ø)
pdata/internal/traceid.go 100.00% <ø> (ø)
pdata/internal/traces.go 94.28% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac9eb92...5b1009a. Read the comment docs.

- Use copy of the godoc comments from pdata/internal instead of mentioning aliases in pdata/p<signal> public API docs.
- Update godoc strings in both pdata/p<signal> and pdata/internal to keep them consistent.
@dmitryax dmitryax force-pushed the update-pdata-dogoc branch from ddf7aaf to 5b1009a Compare April 14, 2022 21:08
@bogdandrutu bogdandrutu merged commit 9585fd9 into open-telemetry:main Apr 14, 2022
@dmitryax dmitryax deleted the update-pdata-dogoc branch April 15, 2022 00:19
Nicholaswang pushed a commit to Nicholaswang/opentelemetry-collector that referenced this pull request Jun 7, 2022
- Use copy of the godoc comments from pdata/internal instead of mentioning aliases in pdata/p<signal> public API docs.
- Update godoc strings in both pdata/p<signal> and pdata/internal to keep them consistent.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants