dotnet / dotnet/dotnet-api-docs
Incorrect description of ImmutableSet.Builder<T>.UnionWith(IEnumerable<T>)
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
The [description](https://learn.microsoft.com/en-us/dotnet/api/system.collections.immutable.immutablesortedset-1.builder.unionwith?view=net-8.0#system-collections-immutable-immutablesortedset-1-builder-unionwith(system-collections-generic-ienumerable((-0)))) currently says that this function "Modifies the current set so that it contains all elements that are present in both the current set and in the specified collection."
That sure sounds to me like an intersection (or at best a no-op), not a union. Seems like this should be changed to be more in line with the [description from ```ISet```](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.iset-1.unionwith?view=net-8.0#system-collections-generic-iset-1-unionwith(system-collections-generic-ienumerable((-0)))), which is "Modifies the current set so that it contains all elements that are present in the current set, in the specified collection, or in both."
I don't really know how automatically the documentation updates, so to be clear just in case, this incorrect description is also contained in the function's brief entry on [the documentation page for the class](https://learn.microsoft.com/en-us/dotnet/api/system.collections.immutable.immutablesortedset-1.builder?view=net-8.0).
It or something similar may or may not also be present in the documentation for similar functions in similar interfaces and/or classes; I have not checked any other than ```ImmutableSet.Builder``` itself.
Contributor guide
Assessment
This issue has not been assessed yet.