`SocketsHttpHandler` need more detailed docs

Open Beginner friendly
#12,768 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp
Domain
documentation

Research direction

Start with the linked SocketsHttpHandler.ConnectCallback API reference and inspect its current documentation. Verify and document what happens when the callback returns an SslStream, including whether the TLS handshake is skipped. Done means the API page clearly explains this behavior for readers using ConnectCallback.

Written by the indexing model from the issue text.

Description

area-System.Net.Http untriaged
Describe the issue or suggestion

Such as SocketsHttpHandler.ConnectCallback, it doesn't said what will happen if I return a SslStream.

Actually, it will skip the TLS handshake - this is what GitHub Copilot told me.

Dominant language
C#
Stars
950
Forks
1.7k
Avg merge
3d 5h
Merged PRs (30d)
38

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/dotnet-api-docs

All issues in dotnet/dotnet-api-docs

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.