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

Simplify language for async API use outside of callback #3537

Merged
merged 2 commits into from
Jun 6, 2023

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Jun 5, 2023

  • Using the term "appurtenant" is not necessary and makes the meaning of the sentence unclear.
  • Scoping the use of these APIs to the "context of a single MetricReader collection" is a meaningless statement. They should be disregarded in all context outside of a callback.
  • Remove the qualifier that the use has to be "accidental". This was likely originally included to explain why a user would do this, but it also complicates things as the implementer may think they need to determine if the use was accidental or not.

@MrAlias MrAlias added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Jun 5, 2023
@MrAlias MrAlias requested review from a team June 5, 2023 16:14
@jack-berg
Copy link
Member

This reads more clearly to me.

@arminru arminru added spec:metrics Related to the specification/metrics directory area:sdk Related to the SDK labels Jun 6, 2023
@reyang reyang merged commit 976432b into open-telemetry:main Jun 6, 2023
@MrAlias MrAlias deleted the simplify branch June 6, 2023 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:sdk Related to the SDK editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants