Fix mentions of equality comparison for collections#12330
Fix mentions of equality comparison for collections#12330svick wants to merge 1 commit intodotnet:mainfrom
Conversation
|
Tagging subscribers to this area: @dotnet/area-system-collections |
There was a problem hiding this comment.
Pull request overview
This PR corrects documentation inaccuracies regarding equality comparison mechanisms in .NET collection types. The changes fix incorrect references to Comparer<T> and IComparer<T> (which are for ordering comparisons) by replacing them with the correct EqualityComparer<T> and IEqualityComparer<T> types (which are for equality comparisons). Additionally, the documentation for Array and List<T> methods is simplified to reference EqualityComparer<T>.Default instead of providing potentially misleading explanations about how equality is determined.
Changes:
- Corrected
ICollection<T>.ContainsandRemovedocumentation to reference equality comparers instead of ordering comparers - Updated
Array.IndexOfoverloads documentation to link toEqualityComparer<T>.Default - Updated
List<T>.ContainsandIndexOfdocumentation to link toEqualityComparer<T>.Default
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| xml/System/Array.xml | Updated six IndexOf method overload remarks to reference EqualityComparer<T>.Default instead of explaining Equals method behavior |
| xml/System.Collections.Generic/List`1.xml | Corrected Contains and IndexOf remarks to reference EqualityComparer<T>.Default |
| xml/System.Collections.Generic/ICollection`1.xml | Fixed incorrect references from Comparer<T>/IComparer<T> to EqualityComparer<T>/IEqualityComparer<T> in Contains and Remove remarks |
For
ICollection<T>.ContainsandRemove, the relevant types are(I)EqualityComparer<T>, not(I)Comparer<T>.For
List<T>andArray, don't try to (badly) explain their behavior, instead link toEqualityComparer<T>.Default.