dotnet / dotnet/dotnet-api-docs
ValueTask.AsTask & ValueTask<TResult>.AsTask – useless remarks; should state usage guideliness
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
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)
Contributor guide
Assessment
This issue has not been assessed yet.