dotnet / dotnet/dotnet-api-docs
ValueTask.AsTask & ValueTask<TResult>.AsTask – useless remarks; should state usage guideliness
- Vorherrschende Sprache
- C#
- Sterne
- 949
- Forks
- 1.7k
- Ø Merge
- 2 T. 19 Std.
- Gemergte PRs (30 T.)
- 52
Beschreibung
Regard [ValueTask Struct|Remarks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1?view=net-5.0#remarks) and [ValueTask Struct|Remarks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask?view=net-5.0#remarks) is not recommended to call `AsTask` multiply times.
I made brief check with `Value`/`ValueTask` and it seems this property belongs only to `IValueTaskSource`/`IValueTaskSource` tasks.
This fact with explanation should be stated in _Remarks_ instead of repeating what is stated in _Returns_ section.
---
- [`ValueTask.AsTask`|Remarks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask.astask?view=net-5.0#remarks)
- [`ValueTask.AsTask`|Remarks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.valuetask-1.astask?view=net-5.0#remarks)
Beitragsleitfaden
Rechercherichtung
Öffnen Sie die verknüpften Remarks-Abschnitte für ValueTask.AsTask und ValueTask.AsTask und vergleichen Sie deren aktuellen Text mit den Returns-Abschnitten. Aktualisieren Sie beide Einträge, damit sie die Nutzungshinweise zum mehrfachen Aufrufen von AsTask und zu den IValueTaskSource-Fällen erläutern, und überprüfen Sie anschließend, dass die Remarks nicht mehr lediglich die Returns wiederholen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 52/100