Disable warning for no awaits in async method #175
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 warning CS1988 is confusing when you implement an interface that requires a
Task
return value as inIDataProcessor
. The message and suggestion to make the method synchronous or useawait Task.Run(...)
is just plain wrong (for the case when you implement an interface that requires aTask
return value).The solution typically is to write
await Task.CompletedTask;
just to "await something" to ignore the warning, or remove theasync
keyword andreturn Task.FromResult(true)
. None of these "solutions" to the warning is actually improves performance or readability.This PR proposes to disable this warning for apps, so that app developers can have warning free apps and consistent code whether they call an async api in their events or not.
Verification
Documentation