dotnet / dotnet/dotnet-api-docs

Documentation of returning Task<T>

Open
#2,632 0 comments 0 reactions 0 assignees View on GitHub
area-System.Threading.Tasks Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

When returning `Task`, if I follow the current documentation I would just say "A task that represents the asynchronous operation". This does not say anything about `T` though. Would something more like [TextReader.ReadAsync](https://docs.microsoft.com/en-us/dotnet/api/system.io.textreader.readasync?view=netcore-2.2)'s text make more sense?

> A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.