Skip to content

Commit 20e5657

Browse files
authored
Fix incorrect xref in StructuralComparisons.xml (#9832)
The remarks for `StructuralComparisons.StructuralEqualityComparer` incorrectly state the property returns an `IComparer` object, when it actually returns an `IEqualityComparer`.
1 parent 7cb362d commit 20e5657

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

xml/System.Collections/StructuralComparisons.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163
<format type="text/markdown"><![CDATA[
164164
165165
## Remarks
166-
When the <xref:System.Collections.IComparer> object returned by this property is passed to the equality comparison method of a collection object, such as <xref:System.Array.System%23Collections%23IStructuralEquatable%23Equals%28System.Object%2CSystem.Collections.IEqualityComparer%29?displayProperty=nameWithType> or <xref:System.Tuple%603.System%23Collections%23IStructuralEquatable%23Equals%28System.Object%2CSystem.Collections.IEqualityComparer%29?displayProperty=nameWithType>, its <xref:System.Collections.IEqualityComparer.Equals%2A?displayProperty=nameWithType> method is called for each member of an array or for each component of a tuple. This implementation of the <xref:System.Collections.IEqualityComparer.Equals%2A> method behaves as follows when it compares each item of a collection object with the corresponding item of another collection object:
166+
When the <xref:System.Collections.IEqualityComparer> object returned by this property is passed to the equality comparison method of a collection object, such as <xref:System.Array.System%23Collections%23IStructuralEquatable%23Equals%28System.Object%2CSystem.Collections.IEqualityComparer%29?displayProperty=nameWithType> or <xref:System.Tuple%603.System%23Collections%23IStructuralEquatable%23Equals%28System.Object%2CSystem.Collections.IEqualityComparer%29?displayProperty=nameWithType>, its <xref:System.Collections.IEqualityComparer.Equals%2A?displayProperty=nameWithType> method is called for each member of an array or for each component of a tuple. This implementation of the <xref:System.Collections.IEqualityComparer.Equals%2A> method behaves as follows when it compares each item of a collection object with the corresponding item of another collection object:
167167
168168
- If both items are `null`, it considers the two items to be equal.
169169

0 commit comments

Comments
 (0)