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: fix histogram type documentation #1427

Merged

Conversation

TigerHe7
Copy link
Contributor

Fixes: #1426

Issue:
The documentation for the histogram type is incorrect in stating that the explicit bucket boundaries are inclusive upper bounds when they are actually inclusive lower bounds.

Changes:

  • Updates comment for histogram type to be accurate
  • Adds unit test to demonstrate inclusive lower bound behavior of bucket boundaries

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 14, 2020

CLA Check
The committers are authorized under a signed CLA.

@codecov
Copy link

codecov bot commented Aug 14, 2020

Codecov Report

Merging #1427 into master will decrease coverage by 0.06%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1427      +/-   ##
==========================================
- Coverage   94.10%   94.03%   -0.07%     
==========================================
  Files         145      119      -26     
  Lines        4341     3889     -452     
  Branches      886      824      -62     
==========================================
- Hits         4085     3657     -428     
+ Misses        256      232      -24     
Impacted Files Coverage Δ
packages/opentelemetry-metrics/src/Meter.ts
...emetry-metrics/src/export/aggregators/Histogram.ts
packages/opentelemetry-metrics/src/Metric.ts
...emetry-metrics/src/export/ConsoleMetricExporter.ts
...s/opentelemetry-metrics/src/BatchObserverResult.ts
...ackages/opentelemetry-metrics/src/MeterProvider.ts
...ackages/opentelemetry-metrics/src/CounterMetric.ts
...trics/src/export/aggregators/MinMaxLastSumCount.ts
...ckages/opentelemetry-metrics/src/ObserverResult.ts
...s/opentelemetry-metrics/src/BatchObserverMetric.ts
... and 16 more

@dyladan dyladan added document Documentation-related express labels Aug 14, 2020
@mayurkale22 mayurkale22 merged commit d511a0e into open-telemetry:master Aug 17, 2020
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

In-line documentation on histogram buckets is incorrect
5 participants