Add docs for AsyncInterfaces #88432
Merged
Add docs for AsyncInterfaces #88432
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
dotnet-issue-labeler
bot
added
the
needs-area-label
stephentoub
reviewed
Jul 5, 2023
| @@ -18,6 +18,8 @@ internal ConfiguredAsyncDisposable(IAsyncDisposable source, bool continueOnCaptu | |||
| _continueOnCapturedContext = continueOnCapturedContext; | |||
| } | |||
|
|
|||
| /// <summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary> | |||
| /// <returns>A task that represents the asynchronous dispose operation.</returns> | |||
There was a problem hiding this comment.
It's not actually a task. But I see this matches what we have documented, so, fine for now.
There was a problem hiding this comment.
I've seen other places where we say "A task that represents" when the returned value is the result of a ConfigureAwait.
For future reference, what description would you prefer to use in plain English for these cases? Would this work?:
"An awaitable, configured value task that represents..."
Or would you use something else?
stephentoub
approved these changes
Jul 5, 2023
|
Failure is known issue #35066 |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #87722
I just copied these from the shipping XML docs.