dotnet / dotnet/dotnet-api-docs

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

Offen
#9,802 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.Collections Pri3 untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
50/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.