FIx multiple typos in documentation

Author: x-sheep

README.md

@@ -101,7 +101,7 @@ Enable the shrinker by adding the `shrinking` trait:
 @Test(.shrinking) func checkSumInRange() async
 ```
 
-After shrinking, the new failing case is `[46, 97, 68, 23, 16]`, which sums to exactly `250`. The first few elements have been removed, which the middle element has been reduced to be closer to the edge.
+After shrinking, the new failing case is `[46, 97, 68, 23, 16]`, which sums to exactly `250`. The first few elements have been removed, while the middle element has been reduced to be closer to the edge.
 
 When using the built-in generators and the `zip` function, shrinkers will also be composed.
 

Sources/PropertyBased/Gen+Float.swift

@@ -28,14 +28,14 @@ extension Gen where Value: BinaryFloatingPoint & Sendable, Value.RawSignificand:
 }
 
 extension Gen where Value == Float {
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func float(in range: ClosedRange<Float>) -> Generator<Float, Shrink.Floating<Float>> { return value(in: range) }
 
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
@@ -44,14 +44,14 @@ extension Gen where Value == Float {
 }
 
 extension Gen where Value == Double {
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func double(in range: ClosedRange<Double>) -> Generator<Double, Shrink.Floating<Double>> { return value(in: range) }
 
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
@@ -61,14 +61,14 @@ extension Gen where Value == Double {
 
 @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)
 extension Gen where Value == Float16 {
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func float16(in range: ClosedRange<Float16>) -> Generator<Float16, Shrink.Floating<Float16>> { return value(in: range) }
 
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
@@ -78,14 +78,14 @@ extension Gen where Value == Float16 {
 
 #if !(os(Windows) || os(Android)) && (arch(i386) || arch(x86_64))
 extension Gen where Value == Float80 {
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func float80(in range: ClosedRange<Float80>) -> Generator<Float80, Shrink.Floating<Float80>> { return value(in: range) }
 
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
@@ -97,14 +97,14 @@ extension Gen where Value == Float80 {
 #if canImport(Foundation)
 import Foundation
 extension Gen where Value == CGFloat {
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func cgFloat(in range: ClosedRange<CGFloat>) -> Generator<CGFloat, Shrink.Floating<CGFloat>> { return value(in: range) }
 
-    /// Produces a generator of random values within the specified range.
+    /// Produces a generator of random floats within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value. `range` must be finite.
     /// - Returns: A generator of random values within the bounds of range.

Sources/PropertyBased/Gen+Int.swift

@@ -2,10 +2,10 @@
 // Copyright (c) 2019 Point-Free, Inc. MIT License
 
 extension Gen where Value: FixedWidthInteger & Sendable {
-    /// Produces a generator of random integers within the specified range.
+    /// Produces a generator of random values within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value.
-    /// - Returns: A generator of random integers within the bounds of range.
+    /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func value(in range: ClosedRange<Value> = Value.min ... Value.max) -> Generator<Value, Shrink.Integer<Value>> {
         return .init(
@@ -14,10 +14,10 @@ extension Gen where Value: FixedWidthInteger & Sendable {
         )
     }
 
-    /// Produces a generator of random integers within the specified range.
+    /// Produces a generator of random values within the specified range.
     ///
     /// - Parameter range: The range in which to create a random value.
-    /// - Returns: A generator of random integers within the bounds of range.
+    /// - Returns: A generator of random values within the bounds of range.
     @inlinable
     public static func value(in range: some RangeExpression<Value>) -> Generator<Value, Shrink.Integer<Value>> {
         return value(in: ClosedRange(range))

Sources/PropertyBased/PropertyCheck.swift

@@ -88,7 +88,7 @@ import Testing
 /// @Test(.shrinking) func checkSumInRange() async
 /// ```
 ///
-/// After shrinking, the new failing case is `[46, 97, 68, 23, 16]`, which sums to exactly `250`. The first few elements have been removed, which the middle element has been reduced to be closer to the edge.
+/// After shrinking, the new failing case is `[46, 97, 68, 23, 16]`, which sums to exactly `250`. The first few elements have been removed, while the middle element has been reduced to be closer to the edge.
 ///
 /// When using built-in generators and the `zip` function to combine them, shrinkers will also be composed.
 ///

Sources/PropertyBased/Shrink+Float.swift

@@ -63,7 +63,7 @@ extension FloatingPoint {
     /// Get a shrinking sequence that shrinks this value to a specific value.
     ///
     /// If this value or the given bound is NaN, the sequence is empty.
-    /// - Parameter bound: The value to shrink to.
+    /// - Parameter bound: The value to shrink towards.
     /// - Returns: A new sequence.
     @inlinable
     public func shrink(towards bound: Self) -> Shrink.Floating<Self> {
@@ -86,15 +86,42 @@ extension FloatingPoint {
         }
     }
 
+    /// Get a shrinking sequence that shrinks this value as close to the given bound as possible.
+    ///
+    /// If this value is NaN, the sequence is empty.
+    /// - Parameter range: If this range doesn't contain the `bound` parameter, the bound closest to the `bound` parameter will be used.
+    /// - Parameter bound: The preferred bound to shrink towards. Defaults to zero.
+    /// - Returns: A new sequence.
     @inlinable public func shrink(within range: Range<Self>, towards bound: Self = 0) -> Shrink.Floating<Self> {
         shrink(within: range.lowerBound ... range.upperBound.nextDown, towards: bound)
     }
+
+    /// Get a shrinking sequence that shrinks this value as close to the given bound as possible.
+    ///
+    /// If this value is NaN, the sequence is empty.
+    /// - Parameter range: If this range doesn't contain the `bound` parameter, the bound closest to the `bound` parameter will be used.
+    /// - Parameter bound: The preferred bound to shrink towards. Defaults to zero.
+    /// - Returns: A new sequence.
     @inlinable public func shrink(within range: PartialRangeThrough<Self>, towards bound: Self = 0) -> Shrink.Floating<Self> {
         shrink(towards: min(bound, range.upperBound))
     }
+
+    /// Get a shrinking sequence that shrinks this value as close to the given bound as possible.
+    ///
+    /// If this value is NaN, the sequence is empty.
+    /// - Parameter range: If this range doesn't contain the `bound` parameter, the bound closest to the `bound` parameter will be used.
+    /// - Parameter bound: The preferred bound to shrink towards. Defaults to zero.
+    /// - Returns: A new sequence.
     @inlinable public func shrink(within range: PartialRangeUpTo<Self>, towards bound: Self = 0) -> Shrink.Floating<Self> {
         shrink(towards: min(bound, range.upperBound.nextDown))
     }
+
+    /// Get a shrinking sequence that shrinks this value as close to the given bound as possible.
+    ///
+    /// If this value is NaN, the sequence is empty.
+    /// - Parameter range: If this range doesn't contain the `bound` parameter, the bound closest to the `bound` parameter will be used.
+    /// - Parameter bound: The preferred bound to shrink towards. Defaults to zero.
+    /// - Returns: A new sequence.
     @inlinable public func shrink(within range: PartialRangeFrom<Self>, towards bound: Self = 0) -> Shrink.Floating<Self> {
         shrink(towards: max(bound, range.lowerBound))
     }

Sources/PropertyBased/Shrink+Integer.swift

@@ -60,7 +60,7 @@ extension Shrink {
 
 extension FixedWidthInteger {
     /// Get a shrinking sequence that shrinks this value to a specific value.
-    /// - Parameter bound: The value to shrink to.
+    /// - Parameter bound: The value to shrink towards.
     /// - Returns: A new sequence.
     @inlinable
     public func shrink(towards bound: Self) -> Shrink.Integer<Self> {
@@ -81,6 +81,10 @@ extension FixedWidthInteger {
         }
     }
 
+    /// Get a shrinking sequence that shrinks this value as close to the given bound as possible.
+    /// - Parameter range: If this range doesn't contain the `bound` parameter, the bound closest to the `bound` parameter will be used.
+    /// - Parameter bound: The preferred bound to shrink towards. Defaults to zero.
+    /// - Returns: A new sequence.
     @inlinable
     public func shrink(within range: some RangeExpression<Self>, towards bound: Self = 0) -> Shrink.Integer<Self> {
         shrink(within: ClosedRange(range), towards: bound)