dotnet / dotnet/dotnet-api-docs

Revisit System.Net.Security.NegotiateStream async examples

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

Description

There are several issues with `System.Net.Security.NegotiateStream` async examples:

There are inconsistencies between C# and C++, VB type of API.

While the C# uses XxxAsync() calls the C++ and VB uses BeginXxx(), EndXxx() methods.

This leads to a situation that:
1) for BeginXxx() we have wrong C# example: https://docs.microsoft.com/en-us/dotnet/api/system.net.security.negotiatestream.beginread?view=netcore-3.1
2) for XxxAsync() methods we don't have linked examples although it is available

There are also references to missing C# sections while the reference is valid for C++, VB which leads to empty code block in C# view: https://docs.microsoft.com/en-us/dotnet/api/system.net.security.negotiatestream.endwrite?view=netcore-3.1

My recommendation is to maintain only XxxAsync methods for all languages as BeginXxx() and EndXxx() are a legacy way of asynchronous programming.

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.