Skip to content

[DOC] Small fix for Histogram documentation.#2156

Merged
marcalff merged 3 commits intoopen-telemetry:mainfrom
lalitb:update-docs
May 26, 2023
Merged

[DOC] Small fix for Histogram documentation.#2156
marcalff merged 3 commits intoopen-telemetry:mainfrom
lalitb:update-docs

Conversation

@lalitb
Copy link
Copy Markdown
Member

@lalitb lalitb commented May 24, 2023

Fixes # (issue)

Changes

The comment is not consistent with implementation and specification. The Histogram API only records non-negative value.

Please provide a brief description of the changes here.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

@lalitb lalitb requested a review from a team May 24, 2023 22:20
@codecov
Copy link
Copy Markdown

codecov bot commented May 24, 2023

Codecov Report

Merging #2156 (a8763f7) into main (770fce3) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2156      +/-   ##
==========================================
- Coverage   87.17%   87.15%   -0.02%     
==========================================
  Files         166      166              
  Lines        4777     4777              
==========================================
- Hits         4164     4163       -1     
- Misses        613      614       +1     
Impacted Files Coverage Δ
...i/include/opentelemetry/metrics/sync_instruments.h 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

Comment thread api/include/opentelemetry/metrics/sync_instruments.h Outdated
Copy link
Copy Markdown
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the fix.

Copy link
Copy Markdown
Member

@esigo esigo left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks :)

@marcalff marcalff changed the title Small fix for Histogram documentation. [DOC] Small fix for Histogram documentation. May 26, 2023
@marcalff marcalff merged commit 5e290c9 into open-telemetry:main May 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants