dotnet / dotnet/dotnet-api-docs

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

Open
#9,802 1 comment 0 reactions 0 assignees View on GitHub
area-System.Collections Pri3 untriaged
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

Open the contributing guide

Research direction

Open the ImmutableSet.Builder.UnionWith(IEnumerable) API entry and compare its description with ISet.UnionWith. Also check the brief entry on the ImmutableSet.Builder class documentation page. Done means both references accurately describe union semantics and use consistent wording.

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
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.