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

Docs: Document the HrTime format #2604

Merged
merged 4 commits into from
Nov 5, 2021

Conversation

JamesJHPark
Copy link
Contributor

Which problem is this PR solving?

This PR is to address and document the HrTime format, HrTime = [number, number], to specify the representation of the first and second number.

Fixes #2578

Short description of the changes

This PR has documented the HrTime format.

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

N/A

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@JamesJHPark JamesJHPark requested a review from a team November 5, 2021 18:15
@codecov
Copy link

codecov bot commented Nov 5, 2021

Codecov Report

Merging #2604 (cc7afd2) into main (491dd80) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2604      +/-   ##
==========================================
+ Coverage   93.00%   93.02%   +0.01%     
==========================================
  Files         138      138              
  Lines        5092     5092              
  Branches     1095     1095              
==========================================
+ Hits         4736     4737       +1     
+ Misses        356      355       -1     
Impacted Files Coverage Δ
packages/opentelemetry-core/src/common/time.ts 95.38% <ø> (ø)
...emetry-core/src/platform/node/RandomIdGenerator.ts 93.75% <0.00%> (+6.25%) ⬆️

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.

Thanks for the contribution

Copy link
Member

@Flarna Flarna left a comment

Choose a reason for hiding this comment

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

@dyladan
Copy link
Member

dyladan commented Nov 5, 2021

Would be cool to have this doc also in API (e.g. open-telemetry/opentelemetry-js-api@a752e7f/src/common/Time.ts#L16)

@JamesJHPark you mind documenting the type there also?

@JamesJHPark
Copy link
Contributor Author

Would be cool to have this doc also in API (e.g. open-telemetry/opentelemetry-js-api@a752e7f/src/common/Time.ts#L16)

@JamesJHPark you mind documenting the type there also?

Yes, definitely! I will document and update it in opentelemetry-js-api.

@dyladan
Copy link
Member

dyladan commented Nov 5, 2021

I cannot merge branches that are out of date with the main branch. Please update this branch and I will merge it

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.

Document the HrTime format
3 participants