Dotnet-api-docs: Missing data

[jfranki]

Definitions both for the method and its parameters are missing. Also for the return value and there are no exceptions. Would be great an example using a cancellation token.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 87fffb1e-8373-4aca-dc0d-89b4d8507124
• Version Independent ID: 7311cb48-8da9-b0d0-9da2-0292f8ce1b58
• Content: NetworkStream.ReadAsync(Byte[], Int32, Int32, CancellationToken) Method (System.Net.Sockets)
• Content Source: xml/System.Net.Sockets/NetworkStream.xml
• Service: unspecified
• GitHub Login: @dotnet-bot
• Microsoft Alias: dotnetcontent

[mairaw]

Thanks @jfranki for your feedback. You're right. We do have a lot of APIs for .NET Core that are missing docs and we have a goal of adding the documentation for those over time. Here's the issue where we tracking this as a project: #2855.

For now, the best workaround until we get those documented is to see the source file at https://github.com/dotnet/corefx/blob/master/src/System.Net.Sockets/src/System/Net/Sockets/NetworkStream.cs#L691.

[mairaw]

I've scheduled this for a future sprint.

[mairaw]

Moving to the backlog until I can actually pick this up to start working on it.

[dinobu]

How is this documentation helpful again?

[mairaw]

The definitions were added to the docs a while back. Given the low number of visits to this particular API, I think the probability of getting an example added would be low, so closing this.