dotnet-api-docs icon indicating copy to clipboard operation
dotnet-api-docs copied to clipboard

Incorrect description of ImmutableSet.Builder<T>.UnionWith(IEnumerable<T>)

Open rwv37 opened this issue 1 year ago • 1 comments

The description 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<T>, 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.

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<T>.Builder itself.

rwv37 avatar Apr 08 '24 21:04 rwv37

Tagging subscribers to this area: @dotnet/area-system-collections