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.

Sign up for GitHub

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

Jump to bottom

chore: improve API documentation #1106

Merged
merged 4 commits into from
May 28, 2020
Merged

chore: improve API documentation #1106

merged 4 commits into from
May 28, 2020

Conversation

mayurkale22
Copy link
Member

No description provided.

@codecov
Copy link

codecov bot commented May 25, 2020 •
edited
Loading

Codecov Report

Merging #1106 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1106   +/-   ##
=======================================
  Coverage   92.36%   92.36%           
=======================================
  Files         115      115           
  Lines        3407     3407           
  Branches      686      686           
=======================================
  Hits         3147     3147           
  Misses        260      260
Impacted Files Coverage Δ
packages/opentelemetry-api/src/metrics/Metric.ts 100.00% <ø> (ø)
.../opentelemetry-api/src/trace/NoopTracerProvider.ts 60.00% <ø> (ø)

@mayurkale22 mayurkale22 added the document Documentation-related label May 26, 2020
mwear
mwear approved these changes May 27, 2020
View reviewed changes
Copy link
Member

@mwear mwear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

packages/opentelemetry-api/src/trace/attributes.ts Show resolved Hide resolved
obecny
obecny approved these changes May 27, 2020
View reviewed changes
Copy link
Member

@obecny obecny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, one comment

packages/opentelemetry-api/README.md Show resolved Hide resolved
@mayurkale22 mayurkale22 force-pushed the improve_documentation branch from 7536635 to 445e61d Compare May 28, 2020 04:53
@dyladan dyladan added the Merge:LGTM This PR is ready to be merged by a Maintainer (has enough valid approvals, successful build, etc.) label May 28, 2020
@mayurkale22 mayurkale22 merged commit 177f672 into open-telemetry:master May 28, 2020
@mayurkale22 mayurkale22 deleted the improve_documentation branch May 28, 2020 17:29
dyladan added a commit to dyladan/opentelemetry-js that referenced this pull request Sep 9, 2022
@mayurkale22 @dyladan
chore: improve API documentation (open-telemetry#1106)
3ffb058 
* chore: improve API documentation

* chore: add @link

* fix: code review

Co-authored-by: Daniel Dyla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dyladan dyladan dyladan approved these changes

@mwear mwear mwear approved these changes

@obecny obecny obecny approved these changes

@bg451 bg451 Awaiting requested review from bg451

@markwolff markwolff Awaiting requested review from markwolff

@OlivierAlbertini OlivierAlbertini Awaiting requested review from OlivierAlbertini

@rochdev rochdev Awaiting requested review from rochdev

@vmarchaud vmarchaud Awaiting requested review from vmarchaud

Assignees
No one assigned
Labels
document Documentation-related Merge:LGTM This PR is ready to be merged by a Maintainer (has enough valid approvals, successful build, etc.)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mayurkale22 @obecny @dyladan @mwear