Improve "Async return types" docs #47289
Open
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.
Summary
This PR rephrases a misleading statement regarding an
awaiter type
- anAsyncMethodBuilderAttribute
should be applied on a type that an async method returns, not on a type thatGetAwaiter()
method returns.The same requirement is showcased in the spec - https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/classes#15141-general.
As an example:
Rigth now the documentation states that an
AsyncMethodBuilderAttribute
should be applied on aCustomAwaiter
type from the example above, which is misleading.Internal previews