dotnet / dotnet/dotnet-api-docs

Task.Wait docs don't tell what happens to Task after timeout

Offen
#3,602 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.Threading.Tasks Pri3 untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

The Task.Wait methods which accept timeout as a parameter, can complete before the Task itself completes. [The docs](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task.wait) don't tell explicitly what happens to the Task itself in such scenario, which I observed to lead to some confusion.

Would it be ok to add an information that "the Task itself is not stopped" at the end of the remark about timeout elpapsing?

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der in der Issue verlinkten Dokumentation zur Task.Wait API und konzentriere dich auf die Anmerkung, die beschreibt, was passiert, wenn das Timeout abläuft. Aktualisiere die Dokumentation so, dass sie angibt, dass die Task selbst nicht gestoppt wird, und ziehe die Arbeit als abgeschlossen in Betracht, sobald dieses Verhalten für die Methoden, die ein Timeout entgegennehmen, explizit ist.

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
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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