dotnet / dotnet/dotnet-api-docs

Describe ConfigureAwait(false) case

Open
#6,624 3 comments 0 reactions 0 assignees View on GitHub
area-System.Threading.Tasks Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

WRT: https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Threading.Tasks/Task.xml

Everyone uses `ConfigureAwait(false)` but the docs only mentions the true case and it's quite hard to understand what it implies.

I have seen great blogs on the topic such as: https://devblogs.microsoft.com/dotnet/configureawait-faq/

IMHO the docs should provide meaningful context about this commonly but IMHO poorly understood function.

At least a link to great blogs would be great :)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.