Change Rank docs && Person sequence order

Author: Head0nF1re

Source/SuperLinq.Async/Rank.cs

@@ -4,8 +4,7 @@ public static partial class AsyncSuperEnumerable
 {
 	/// <summary>
 	/// Ranks each item in the sequence in ascending order using a default comparer.
-	/// The rank is equal to index + 1 of the first next different item, the first item
-	/// has a rank of 1 (index 0 + 1).
+	/// The rank is equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">Type of item in the sequence</typeparam>
 	/// <param name="source">The sequence whose items will be ranked</param>
@@ -19,8 +18,7 @@ public static partial class AsyncSuperEnumerable
 
 	/// <summary>
 	/// Ranks each item in the sequence in ascending order using a caller-supplied comparer.
-	/// The rank is equal to index + 1 of the first next different item, the first item
-	/// has a rank of 1 (index 0 + 1).
+	/// The rank is equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <param name="source">The sequence of items to rank</param>
@@ -35,8 +33,7 @@ public static partial class AsyncSuperEnumerable
 
 	/// <summary>
 	/// Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/>
-	/// using a default comparer. The rank is equal to index + 1 of the first next different
-	/// item, the first item has a rank of 1 (index 0 + 1).
+	/// using a default comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">Type of item in the sequence</typeparam>
 	/// <param name="source">The sequence whose items will be ranked</param>
@@ -51,8 +48,7 @@ public static partial class AsyncSuperEnumerable
 
 	/// <summary>
 	/// Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/>
-	/// using a caller-supplied comparer. The rank is equal to index + 1 of the first next
-	/// different item, the first item has a rank of 1 (index 0 + 1).
+	/// using a caller-supplied comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <param name="source">The sequence of items to rank</param>

Source/SuperLinq.Async/RankBy.cs

@@ -5,7 +5,7 @@ public static partial class AsyncSuperEnumerable
 	/// <summary>
 	/// Ranks each item in the sequence in ascending order by a specified key
 	/// using a default comparer. The rank is equal to index + 1 of the first
-	/// next different item, the first item has a rank of 1 (index 0 + 1).
+	/// element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <typeparam name="TKey">The type of the key used to rank items in the sequence</typeparam>
@@ -26,7 +26,7 @@ public static partial class AsyncSuperEnumerable
 	/// <summary>
 	/// Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/>
 	/// by a specified key using a default comparer. The rank is equal to index + 1 of the first
-	/// next different item, the first item has a rank of 1 (index 0 + 1).
+	/// element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <typeparam name="TKey">The type of the key used to rank items in the sequence</typeparam>
@@ -50,7 +50,7 @@ public static partial class AsyncSuperEnumerable
 	/// <summary>
 	/// Ranks each item in the sequence in ascending order by a specified key
 	/// using a caller-supplied comparer. The rank is equal to index + 1 of the first
-	/// next different item, the first item has a rank of 1 (index 0 + 1).
+	/// element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <typeparam name="TKey">The type of the key used to rank items in the sequence</typeparam>
@@ -74,7 +74,7 @@ public static partial class AsyncSuperEnumerable
 	/// <summary>
 	/// Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/>
 	/// by a specified key using a caller-supplied comparer. The rank is equal to index + 1 of the first
-	/// next different item, the first item has a rank of 1 (index 0 + 1).
+	/// element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">The type of the elements in the source sequence</typeparam>
 	/// <typeparam name="TKey">The type of the key used to rank items in the sequence</typeparam>

Source/SuperLinq/Rank.cs

@@ -4,7 +4,7 @@ public static partial class SuperEnumerable
 {
 	/// <summary>
 	///	    Ranks each item in the sequence in ascending order using a default comparer. The rank is equal to
-	///		index + 1 of the first next different item, the first item has a rank of 1 (index 0 + 1).
+	///		index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">
 	///	    Type of item in the sequence
@@ -32,7 +32,7 @@ public static partial class SuperEnumerable
 
 	/// <summary>
 	///	    Ranks each item in the sequence in ascending order using a caller-supplied comparer. The rank is equal to
-	///		index + 1 of the first next different item, the first item has a rank of 1 (index 0 + 1).
+	///		index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">
 	///	    The type of the elements in the source sequence
@@ -63,8 +63,7 @@ public static partial class SuperEnumerable
 
 	///  <summary>
 	/// 	Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/> using a default
-	///		comparer. The rank is equal to index + 1 of the first next different item, the first item has a rank of 1
-	///		(index 0 + 1).
+	///		comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	///  </summary>
 	///  <typeparam name="TSource">
 	/// 	Type of item in the sequence
@@ -95,8 +94,7 @@ public static partial class SuperEnumerable
 
 	///  <summary>
 	/// 	Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/> using a
-	///		caller-supplied comparer. The rank is equal to index + 1 of the first next different item, the first item
-	///		has a rank of 1 (index 0 + 1).
+	///		caller-supplied comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	///  </summary>
 	///  <typeparam name="TSource">
 	/// 	The type of the elements in the source sequence

Source/SuperLinq/RankBy.cs

@@ -4,7 +4,7 @@ public static partial class SuperEnumerable
 {
 	/// <summary>
 	///	    Ranks each item in the sequence in ascending order by a specified key using a default comparer. The rank is
-	///		equal to index + 1 of the first next different item, the first item has a rank of 1 (index 0 + 1).
+	///		equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">
 	///	    The type of the elements in the source sequence
@@ -41,8 +41,7 @@ public static partial class SuperEnumerable
 
 	///  <summary>
 	/// 	Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/> by a specified key
-	///		using a default comparer. The rank is equal to index + 1 of the first next different item, the first item
-	///		has a rank of 1 (index 0 + 1).
+	///		using a default comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	///  </summary>
 	///  <typeparam name="TSource">
 	/// 	The type of the elements in the source sequence
@@ -84,7 +83,7 @@ public static partial class SuperEnumerable
 
 	/// <summary>
 	///	    Ranks each item in the sequence in ascending order by a specified key using a caller-supplied comparer. The
-	///		rank is equal to index + 1 of the first next different item, the first item has a rank of 1 (index 0 + 1).
+	///		rank is equal to index + 1 of the first element of the item's equality set.
 	/// </summary>
 	/// <typeparam name="TSource">
 	///	    The type of the elements in the source sequence
@@ -126,8 +125,7 @@ public static partial class SuperEnumerable
 
 	///  <summary>
 	/// 	Ranks each item in the sequence in the order defined by <paramref name="sortDirection"/> by a specified key
-	///		using a caller-supplied comparer. The rank is equal to index + 1 of the first next different item, the first
-	///		item has a rank of 1 (index 0 + 1).
+	///		using a caller-supplied comparer. The rank is equal to index + 1 of the first element of the item's equality set.
 	///  </summary>
 	///  <typeparam name="TSource">
 	/// 	The type of the elements in the source sequence

Tests/SuperLinq.Async.Test/DenseRankTest.cs

@@ -225,14 +225,14 @@ public async Task TestRankByKeySelector()
 			},
 			new Person[]
 			{
+				new(Name: "Jes", Age: 30, ExpectedRank: 4),
+				new(Name: "Tim", Age: 23, ExpectedRank: 2),
+				new(Name: "Joe", Age: 23, ExpectedRank: 2),
 				new(Name: "Bob", Age: 11, ExpectedRank: 1),
 				new(Name: "Sam", Age: 11, ExpectedRank: 1),
 				new(Name: "Kim", Age: 11, ExpectedRank: 1),
-				new(Name: "Tim", Age: 23, ExpectedRank: 2),
-				new(Name: "Joe", Age: 23, ExpectedRank: 2),
 				new(Name: "Mel", Age: 28, ExpectedRank: 3),
 				new(Name: "Jim", Age: 28, ExpectedRank: 3),
-				new(Name: "Jes", Age: 30, ExpectedRank: 4),
 			},
 		};
 

Tests/SuperLinq.Async.Test/RankTest.cs

@@ -215,14 +215,14 @@ public async Task TestRankByKeySelector()
 			},
 			new Person[]
 			{
+				new(Name: "Tim", Age: 23, ExpectedRank: 4),
+				new(Name: "Joe", Age: 23, ExpectedRank: 4),
+				new(Name: "Jes", Age: 30, ExpectedRank: 8),
 				new(Name: "Bob", Age: 11, ExpectedRank: 1),
 				new(Name: "Sam", Age: 11, ExpectedRank: 1),
 				new(Name: "Kim", Age: 11, ExpectedRank: 1),
-				new(Name: "Tim", Age: 23, ExpectedRank: 4),
-				new(Name: "Joe", Age: 23, ExpectedRank: 4),
 				new(Name: "Mel", Age: 28, ExpectedRank: 6),
 				new(Name: "Jim", Age: 28, ExpectedRank: 6),
-				new(Name: "Jes", Age: 30, ExpectedRank: 8),
 			},
 		};
 

Tests/SuperLinq.Test/DenseRankTest.cs

@@ -210,14 +210,14 @@ public static IEnumerable<object[]> GetPersonSequences1() =>
 	public static IEnumerable<object[]> GetPersonSequences2() =>
 		new[]
 		{
+				new Person(Name: "Jes", Age: 30, ExpectedRank: 4),
+				new Person(Name: "Tim", Age: 23, ExpectedRank: 2),
+				new Person(Name: "Joe", Age: 23, ExpectedRank: 2),
 				new Person(Name: "Bob", Age: 11, ExpectedRank: 1),
 				new Person(Name: "Sam", Age: 11, ExpectedRank: 1),
 				new Person(Name: "Kim", Age: 11, ExpectedRank: 1),
-				new Person(Name: "Tim", Age: 23, ExpectedRank: 2),
-				new Person(Name: "Joe", Age: 23, ExpectedRank: 2),
 				new Person(Name: "Mel", Age: 28, ExpectedRank: 3),
 				new Person(Name: "Jim", Age: 28, ExpectedRank: 3),
-				new Person(Name: "Jes", Age: 30, ExpectedRank: 4),
 		}
 			.GetTestingSequence(maxEnumerations: 3)
 			.Select(x => new object[] { x, });

Tests/SuperLinq.Test/RankTest.cs

@@ -210,14 +210,14 @@ public static IEnumerable<object[]> GetPersonSequences1() =>
 	public static IEnumerable<object[]> GetPersonSequences2() =>
 		new[]
 		{
+				new Person(Name: "Tim", Age: 23, ExpectedRank: 4),
+				new Person(Name: "Joe", Age: 23, ExpectedRank: 4),
+				new Person(Name: "Jes", Age: 30, ExpectedRank: 8),
 				new Person(Name: "Bob", Age: 11, ExpectedRank: 1),
 				new Person(Name: "Sam", Age: 11, ExpectedRank: 1),
 				new Person(Name: "Kim", Age: 11, ExpectedRank: 1),
-				new Person(Name: "Tim", Age: 23, ExpectedRank: 4),
-				new Person(Name: "Joe", Age: 23, ExpectedRank: 4),
 				new Person(Name: "Mel", Age: 28, ExpectedRank: 6),
 				new Person(Name: "Jim", Age: 28, ExpectedRank: 6),
-				new Person(Name: "Jes", Age: 30, ExpectedRank: 8),
 		}
 			.GetTestingSequence(maxEnumerations: 3)
 			.Select(x => new object[] { x, });