dotnet / dotnet/dotnet-api-docs
No "Read" method found on UdpClient
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
### Type of issue
Missing information
### Description
The remarks of the _Available_ property of the **UdpClient**, suggests the next call should be the _Read_ method.
I don't see a Read method in the **UdpClient** implementation.
Could it be "_Receive_"?
> If data is available, call [Read](https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.networkstream.read?view=net-10.0) to get the data.
### Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.udpclient.available?view=net-10.0
### Content source URL
https://github.com/dotnet/dotnet-api-docs-temp/blob/live/xml/System.Net.Sockets/UdpClient.xml
### Document Version Independent Id
10c6f8c8-8764-1afa-a39c-6cbb6e253e0e
### Platform Id
d47f8804-7b14-3ac2-86d0-44dd37582579
### Article author
@karelz
Contributor guide
Research direction
Start with the Available property remarks in the System.Net.Sockets/UdpClient.xml source linked in the issue, and compare the referenced Read method with UdpClient's Receive methods. Update the documentation so it names the applicable method, then verify the generated Available API page no longer points readers to an unavailable method.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100