Clarify asynchronous instrument callback documentation and order-of-execution requirements #2361
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arminru
added
area:api
dyladan
reviewed
Feb 22, 2022
MrAlias
approved these changes
Feb 23, 2022
jack-berg
approved these changes
Feb 25, 2022
jmacd
commented
Mar 1, 2022
…ication into jmacd/require_docs
jmacd
changed the title
|
While resolving with the updates in #2317, it felt important to add one related sentence. The order of callback execution is not specified. I want to add this sentence because even though we already state that users SHOULD NOT observe duplicate asynchronous measurements, I want it to be clear that there is no meaningful concept of "first value observed" or "last value observed". |
bogdandrutu
approved these changes
Mar 1, 2022
cijothomas
approved these changes
Mar 1, 2022
This was referenced Mar 7, 2022
Closed
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #2350
Changes
As noted in #2350 (and a comment in #2317 by @anuraaga), the requirements for callbacks to behave a certain way apply to the user, not the implementation or the API designer. Therefore, specify these as documentation requirements.