dotnet / dotnet/dotnet-api-docs

Task.WaitAsync description is wrong

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

Description

### Type of issue

Other (describe below)

### Description

https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task.waitasync?view=net-10.0#system-threading-tasks-task-waitasync(system-timespan-system-timeprovider)

The description states: "_Gets a Task that will complete when this Task completes or when the specified timeout expires."
This information is wrong_."

When a timeout argument is specified and the timeout expires, the Task.WaitAsync **always** throw a TimeoutException.

Please note that the description is wrong for **all the other overloads**.

### Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task.waitasync?view=net-10.0#system-threading-tasks-task-waitasync(system-timespan-system-timeprovider)

### Content source URL

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

### Document Version Independent Id

4975978e-14a9-88e1-bec2-ea632d3c08d7

### Platform Id

4fa165a2-05cd-c7d8-44d5-b6b3d0d66862

### Article author

@dotnet-bot

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.