dotnet / dotnet/dotnet-api-docs

Incomplete description for Task.Wait(TimeSpan, CancellationToken)

Offen Anfängerfreundlich
#12,759 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.Threading.Tasks untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

### 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Öffne xml/System.Threading.Tasks/Task.xml und finde die Dokumentation für Task.Wait(TimeSpan, CancellationToken). Vergleiche sie mit der Überladung Task.Wait(int, CancellationToken) und aktualisiere die Beschreibung so, dass sie das Ablaufen des Timeouts und die Abbruchanforderung erwähnt. Die Aufgabe ist abgeschlossen, wenn die generierte API-Seite die korrigierte Formulierung für diese Überladung anzeigt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
90/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.