dotnet / dotnet/dotnet-api-docs
Misleading / incorrect documentaion on MulticastLoopback (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 documentation states:
> Gets or sets a [Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean?view=net-10.0) value that specifies whether outgoing multicast packets are delivered to the sending application.
This implies when setting this property to `false`, any multicast messages send by the application are not delivered to that same application, but they would be delivered to all other applications on the same host.
At least on Windows systems this is incorrect. Setting this property to `false` will cause any application in that same Windows host to not receive the messages send. This should be clearly stated in the documentation.
It might be Linux behaviour is different on this topic. If it is, please also state that behaviour clearly.
### Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.udpclient.multicastloopback?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
63254515-ef81-55e3-3b20-e75ed547b4b7
### Platform Id
0d5ffe04-7e97-4651-28f5-9f753cb19712
### Article author
@karelz
Contributor guide
Research direction
Start with the MulticastLoopback entry in xml/System.Net.Sockets/UdpClient.xml and compare it with the published API page. Verify the documented behavior on Windows and, if relevant, Linux, then update the description so platform-specific multicast delivery semantics are explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100