dotnet / dotnet/dotnet-api-docs

ValueTask.AsTask & ValueTask<TResult>.AsTask – useless remarks; should state usage guideliness

Aperta
#7,233 13 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area-System.Threading.Tasks Pri3 untriaged
Lingua principale
C#
Stelle
949
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Apri le sezioni Remarks collegate per ValueTask.AsTask e ValueTask.AsTask e confronta il testo attuale con le sezioni Returns. Aggiorna entrambe le voci per spiegare le indicazioni d’uso relative alla chiamata multipla di AsTask e ai casi IValueTaskSource, quindi verifica che le Remarks non si limitino più a ripetere Returns.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.