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

Chore: minor fixes to API docs #779

Merged
merged 3 commits into from
Feb 18, 2020

Conversation

mayurkale22
Copy link
Member

Short description of the changes

  • Fix API docs

  • Rename NodeTracer to NodeTracerProvider.

  • Add missing @param

  • Indent continuation lines

Copy link
Member

@dyladan dyladan left a comment

Choose a reason for hiding this comment

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

Looks good to me, just a few minor wording suggestions

@codecov-io
Copy link

Codecov Report

Merging #779 into master will increase coverage by 2.96%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #779      +/-   ##
==========================================
+ Coverage    92.4%   95.37%   +2.96%     
==========================================
  Files         237      137     -100     
  Lines       10790     5019    -5771     
  Branches      997      436     -561     
==========================================
- Hits         9971     4787    -5184     
+ Misses        819      232     -587
Impacted Files Coverage Δ
packages/opentelemetry-api/src/metrics/Metric.ts 100% <ø> (ø) ⬆️
...ackages/opentelemetry-api/src/metrics/NoopMeter.ts 81.13% <ø> (ø) ⬆️
packages/opentelemetry-metrics/src/Metric.ts 86.15% <ø> (ø) ⬆️
...ckages/opentelemetry-core/src/common/NoopLogger.ts 40% <0%> (-20%) ⬇️
...metry-core/src/trace/instrumentation/BasePlugin.ts 81.57% <0%> (-5.27%) ⬇️
...core/src/context/propagation/BinaryTraceContext.ts 96.22% <0%> (-3.78%) ⬇️
...ckages/opentelemetry-plugin-ioredis/src/version.ts 100% <0%> (ø) ⬆️
...telemetry-core/src/context/propagation/B3Format.ts 94.59% <0%> (-2.71%) ⬇️
.../opentelemetry-plugin-ioredis/test/ioredis.test.ts 94.63% <0%> (ø) ⬆️
... and 204 more

@dyladan dyladan added document Documentation-related Merge:LGTM This PR is ready to be merged by a Maintainer (has enough valid approvals, successful build, etc.) labels Feb 18, 2020
@dyladan
Copy link
Member

dyladan commented Feb 18, 2020

@mayurkale22 this is so simple that I'm ok with this just merging if you're ok with it. gave my ✅ and added merge:lgtm label. Feel free to merge when you're ready.

@mayurkale22
Copy link
Member Author

@mayurkale22 this is so simple that I'm ok with this just merging if you're ok with it. gave my and added merge:lgtm label. Feel free to merge when you're ready.

+1 feel free to merge 👍

@dyladan dyladan merged commit 014b324 into open-telemetry:master Feb 18, 2020
dyladan pushed a commit to dyladan/opentelemetry-js that referenced this pull request Sep 9, 2022
* chore: fix API docs

* update WEB Readme: WebTracer => WebTracerProvider
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

4 participants