Documentation fixes

Author: rockbruno

Guides/Resources/SortedPrefix/FewElements.png

@@ -1,18 +1,15 @@
-# Partial Sort (sortedPrefix)
+# Sorted Prefix
 
 [[Source](https://github.com/apple/swift-algorithms/blob/main/Sources/Algorithms/PartialSort.swift) | 
  [Tests](https://github.com/apple/swift-algorithms/blob/main/Tests/SwiftAlgorithmsTests/PartialSortTests.swift)]
 
 Returns the first k elements of this collection when it's sorted.
 
-If you need to sort a collection but only need access to a prefix of its
-elements, using this method can give you a performance boost over sorting 
-the entire collection. The order of equal elements is guaranteed to be
-preserved.
+If you need to sort a collection but only need access to a prefix of its elements, using this method can give you a performance boost over sorting the entire collection. The order of equal elements is guaranteed to be preserved.
 
 ```swift
 let numbers = [7,1,6,2,8,3,9]
-let smallestThree = numbers.sortedPrefix(<)
+let smallestThree = numbers.sortedPrefix(3, by: <)
 // [1, 2, 3]
 ```
 
@@ -36,17 +33,16 @@ extension Collection where Element: Comparable {
 
 ### Complexity
 
-The algorithm used is based on [Soroush Khanlou's research on this matter](https://khanlou.com/2018/12/analyzing-complexity/). The total complexity is `O(k log k + nk)`, which will result in a runtime close to `O(n)` if k is a small amount. If k is a large amount (more than 10% of the collection), we fallback to sorting the entire array. Realistically, this means the worst case is actually `O(n log n)`.
+The algorithm used is based on [Soroush Khanlou's research on this matter](https://khanlou.com/2018/12/analyzing-complexity/). The total complexity is `O(k log k + nk)`, which will result in a runtime close to `O(n)` if k is a small amount. If k is a large amount (more than 10% of the collection), we fall back to sorting the entire array. Realistically, this means the worst case is actually `O(n log n)`.
 
 Here are some benchmarks we made that demonstrates how this implementation (SmallestM) behaves when k increases (before implementing the fallback):
 
-![Benchmark](https://i.imgur.com/F5UEQnl.png)
-![Benchmark 2](https://i.imgur.com/Bm9DKRc.png)
+![Benchmark](Resources/SortedPrefix/FewElements.png)
+![Benchmark 2](Resources/SortedPrefix/ManyElements.png)
 
 ### Comparison with other languages
 
 **C++:** The `<algorithm>` library defines a `partial_sort` function where the entire array is returned using a partial heap sort.
 
-**Python:** Defines a `heapq` priority queue that can be used to manually 
-achieve the same result.
+**Python:** Defines a `heapq` priority queue that can be used to manually achieve the same result.
 

Guides/Resources/SortedPrefix/ManyElements.png

@@ -30,7 +30,7 @@ Read more about the package, and the intent behind it, in the [announcement on s
 
 #### Partial sorting
 
-- [`sortedPrefix(_:by:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/PartialSort.md): Returns the first k elements of a sorted collection.
+- [`sortedPrefix(_:by:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/SortedPrefix.md): Returns the first k elements of a sorted collection.
 
 #### Other useful operations
 

Guides/PartialSort.md renamed to Guides/SortedPrefix.md

@@ -17,7 +17,7 @@ extension Collection {
   /// smallest values:
   ///
   ///     let numbers = [7,1,6,2,8,3,9]
-  ///     let smallestThree = numbers.sortedPrefix(3, <)
+  ///     let smallestThree = numbers.sortedPrefix(3, by: <)
   ///     // [1, 2, 3]
   ///
   /// If you need to sort a collection but only need access to a prefix of its
@@ -65,14 +65,14 @@ extension Collection {
 }
 
 extension Collection where Element: Comparable {
-  /// Returns the first k elements of this collection when it's sorted using
-  /// the given predicate as the comparison between elements.
+  /// Returns the first k elements of this collection when it's sorted in
+  /// ascending order.
   ///
   /// This example partially sorts an array of integers to retrieve its three
   /// smallest values:
   ///
   ///     let numbers = [7,1,6,2,8,3,9]
-  ///     let smallestThree = numbers.sortedPrefix(3, <)
+  ///     let smallestThree = numbers.sortedPrefix(3)
   ///     // [1, 2, 3]
   ///
   /// If you need to sort a collection but only need access to a prefix of its

README.md

@@ -12,7 +12,7 @@
 import XCTest
 import Algorithms
 
-final class PartialSortTests: XCTestCase {
+final class SortedPrefixTests: XCTestCase {
   func testEmpty() {
     let array = [Int]()
     XCTAssertEqual(array.sortedPrefix(0), [])