dotnet / dotnet/dotnet-api-docs

Exceptions for `WebSocket.SendAsync(..)` are not mentioned

Aperta
#7,809 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
area-System.Net Pri3 untriaged
Lingua principale
C#
Stelle
949
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

Hi Team,

https://docs.microsoft.com/en-us/dotnet/api/system.net.websockets.websocket.sendasync?view=net-6.0 does not mention any exceptions. However, there are cases when `SendAsync(..)` overloads can throw exceptions:

* https://github.com/dotnet/runtime/blob/a4a6d30517b5b141b3934814100dfb5f20f07d5d/src/libraries/System.Net.WebSockets/src/System/Net/WebSockets/ManagedWebSocket.cs#L238-L241
* https://github.com/dotnet/runtime/blob/a4a6d30517b5b141b3934814100dfb5f20f07d5d/src/libraries/System.Net.WebSockets/src/System/Net/WebSockets/ManagedWebSocket.cs#L264

a probably many more. Are the exceptions documented somewhere or is it a "bug" in documentation?

Regards

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con il riferimento API collegato di WebSocket.SendAsync e confronta le eccezioni documentate con i percorsi delle eccezioni citati in ManagedWebSocket.cs alle righe 238-241 e 264. Controlla gli overload SendAsync disponibili e documenta le eccezioni applicabili, facendo in modo che il riferimento API rifletta il comportamento dell’implementazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.