Make the PeriodicTimer.WaitForNextTickAsync description more descriptive #119637
+1
−1
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the PeriodicTimer.WaitForNextTickAsync method by clarifying the boolean return value semantics and the different completion states of the returned ValueTask.
Key Changes
- Enhanced the XML documentation to explicitly describe when the method returns
truevsfalse - Added clarification about the cancellation behavior and task state
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
jkotas
added
area-System.Threading
documentation
|
Tagging subscribers to this area: @mangod9 |
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.
The current documentation doesn't actually say what the semantics of the result are.