task_control: added a doc comment for TaskControl#3414
Draft
gurasinghMS wants to merge 3 commits intomicrosoft:mainfrom
Draft
task_control: added a doc comment for TaskControl#3414gurasinghMS wants to merge 3 commits intomicrosoft:mainfrom
TaskControl#3414gurasinghMS wants to merge 3 commits intomicrosoft:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds in-crate documentation clarifying the cooperative cancellation model and usage patterns for TaskControl in support/task_control, including guidance for implementing AsyncRun without accidentally dropping in-flight work.
Changes:
- Expanded
TaskControldoc comment to describe lifecycle (insert/start/stop), cooperative cancellation, and interaction withupdate_with+ inspect. - Added a
no_runrustdoc example showing a recommendedAsyncRunpattern (wrap only the “wait for request” await inuntil_stopped).
smalis-msft
approved these changes
May 1, 2026
mattkur
approved these changes
May 1, 2026
Contributor
|
Looks good, but you may want to also put a note in the |
Contributor
Author
|
John mentioned to move the comment to Async run instead. Will update (don't merge yet) |
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
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.
Adding some documentation on how TaskControl should be used. The limitations and nuances of when underlying tasks will be cancelled and expected behavior from
impl AsyncRun for T.