dotnet / dotnet/dotnet-api-docs

Incomplete description for Task.Wait(TimeSpan, CancellationToken)

Open Beginner friendly
#12,759 1 comment 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

Typo

### Description

The description for `Task.Wait(TimeSpan, CancellationToken)` is identical to the description of `Task.Wait()`:

> Waits for the to complete execution.

For consistency with the other overloads, it should probably be closer to the description of `Task.Wait(int, CancellationToken)`:

> Waits for the to complete execution.
> **The wait terminates if a timeout interval elapses or a cancellation token is canceled before the task completes.**

### Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task.wait?view=net-10.0

### Content source URL

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

### Document Version Independent Id

4a689a76-7ebb-8638-1f0a-098a3adb6eea

### Platform Id

f467a857-a9ec-5f14-f4f9-9db1ecb57ead

### Article author

@dotnet-bot

Contributor guide

Open the contributing guide

Research direction

Open xml/System.Threading.Tasks/Task.xml and locate the documentation for Task.Wait(TimeSpan, CancellationToken). Compare it with the Task.Wait(int, CancellationToken) overload and update the description to mention timeout expiration and cancellation. Done means the generated API page shows the corrected wording for this overload.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.