Skip to content

Commit 139c140

Browse files
engyebrahimengyebrahim
authoredJan 20, 2023
Update AreEqual/AreNotEqual XML documentation (#1563)
fix #1551
·
v3.9.0-preview.25167.10v3.1.0
1 parent 02cebe5 commit 139c140

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed
 

‎src/TestFramework/TestFramework/Assertions/Assert.AreEqual.cs

+24-24
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ public sealed partial class Assert
1717
{
1818
/// <summary>
1919
/// Tests whether the specified values are equal and throws an exception
20-
/// if the two values are not equal. Different numeric types are treated
21-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
20+
/// if the two values are not equal.
21+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
2222
/// </summary>
2323
/// <typeparam name="T">
2424
/// The type of values to compare.
@@ -37,8 +37,8 @@ public static void AreEqual<T>(T? expected, T? actual)
3737

3838
/// <summary>
3939
/// Tests whether the specified values are equal and throws an exception
40-
/// if the two values are not equal. Different numeric types are treated
41-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
40+
/// if the two values are not equal.
41+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
4242
/// </summary>
4343
/// <typeparam name="T">
4444
/// The type of values to compare.
@@ -61,8 +61,8 @@ public static void AreEqual<T>(T? expected, T? actual, IEqualityComparer<T>? com
6161

6262
/// <summary>
6363
/// Tests whether the specified values are equal and throws an exception
64-
/// if the two values are not equal. Different numeric types are treated
65-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
64+
/// if the two values are not equal.
65+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
6666
/// </summary>
6767
/// <typeparam name="T">
6868
/// The type of values to compare.
@@ -87,8 +87,8 @@ public static void AreEqual<T>(T? expected, T? actual, string? message)
8787

8888
/// <summary>
8989
/// Tests whether the specified values are equal and throws an exception
90-
/// if the two values are not equal. Different numeric types are treated
91-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
90+
/// if the two values are not equal.
91+
/// The equality is computed using the provided <paramref name="comparer"/> parameter.
9292
/// </summary>
9393
/// <typeparam name="T">
9494
/// The type of values to compare.
@@ -117,8 +117,8 @@ public static void AreEqual<T>(T? expected, T? actual, IEqualityComparer<T>? com
117117

118118
/// <summary>
119119
/// Tests whether the specified values are equal and throws an exception
120-
/// if the two values are not equal. Different numeric types are treated
121-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
120+
/// if the two values are not equal.
121+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
122122
/// </summary>
123123
/// <typeparam name="T">
124124
/// The type of values to compare.
@@ -146,8 +146,8 @@ public static void AreEqual<T>(T? expected, T? actual, string? message, params o
146146

147147
/// <summary>
148148
/// Tests whether the specified values are equal and throws an exception
149-
/// if the two values are not equal. Different numeric types are treated
150-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
149+
/// if the two values are not equal.
150+
/// The equality is computed using the provided <paramref name="comparer"/> parameter.
151151
/// </summary>
152152
/// <typeparam name="T">
153153
/// The type of values to compare.
@@ -205,8 +205,8 @@ public static void AreEqual<T>(T? expected, T? actual, IEqualityComparer<T>? com
205205

206206
/// <summary>
207207
/// Tests whether the specified values are unequal and throws an exception
208-
/// if the two values are equal. Different numeric types are treated
209-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
208+
/// if the two values are equal.
209+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
210210
/// </summary>
211211
/// <typeparam name="T">
212212
/// The type of values to compare.
@@ -226,8 +226,8 @@ public static void AreNotEqual<T>(T? notExpected, T? actual)
226226

227227
/// <summary>
228228
/// Tests whether the specified values are unequal and throws an exception
229-
/// if the two values are equal. Different numeric types are treated
230-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
229+
/// if the two values are equal.
230+
/// The equality is computed using the provided <paramref name="comparer"/> parameter.
231231
/// </summary>
232232
/// <typeparam name="T">
233233
/// The type of values to compare.
@@ -251,8 +251,8 @@ public static void AreNotEqual<T>(T? notExpected, T? actual, IEqualityComparer<T
251251

252252
/// <summary>
253253
/// Tests whether the specified values are unequal and throws an exception
254-
/// if the two values are equal. Different numeric types are treated
255-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
254+
/// if the two values are equal.
255+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
256256
/// </summary>
257257
/// <typeparam name="T">
258258
/// The type of values to compare.
@@ -277,8 +277,8 @@ public static void AreNotEqual<T>(T? notExpected, T? actual, string? message)
277277

278278
/// <summary>
279279
/// Tests whether the specified values are unequal and throws an exception
280-
/// if the two values are equal. Different numeric types are treated
281-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
280+
/// if the two values are equal.
281+
/// The equality is computed using the provided <paramref name="comparer"/> parameter.
282282
/// </summary>
283283
/// <typeparam name="T">
284284
/// The type of values to compare.
@@ -307,8 +307,8 @@ public static void AreNotEqual<T>(T? notExpected, T? actual, IEqualityComparer<T
307307

308308
/// <summary>
309309
/// Tests whether the specified values are unequal and throws an exception
310-
/// if the two values are equal. Different numeric types are treated
311-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
310+
/// if the two values are equal.
311+
/// The equality is computed using the default <see cref="System.Collections.Generic.EqualityComparer{T}"/>.
312312
/// </summary>
313313
/// <typeparam name="T">
314314
/// The type of values to compare.
@@ -336,8 +336,8 @@ public static void AreNotEqual<T>(T? notExpected, T? actual, string? message, pa
336336

337337
/// <summary>
338338
/// Tests whether the specified values are unequal and throws an exception
339-
/// if the two values are equal. Different numeric types are treated
340-
/// as unequal even if the logical values are equal. 42L is not equal to 42.
339+
/// if the two values are equal.
340+
/// The equality is computed using the provided <paramref name="comparer"/> parameter.
341341
/// </summary>
342342
/// <typeparam name="T">
343343
/// The type of values to compare.

0 commit comments

Comments
 (0)
Please sign in to comment.