effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/Order.js

@@ -1,51 +1,80 @@
 /**
- * This module provides the `Order` type class for defining total orderings on types.
- * An `Order` is a comparison function that returns `-1` (less than), `0` (equal), or `1` (greater than).
- *
- * Mental model:
- * - An `Order<A>` is a pure function `(a: A, b: A) => Ordering` that compares two values
- * - The result `-1` means the first value is less than the second
- * - The result `0` means the values are equal according to this ordering
- * - The result `1` means the first value is greater than the second
- * - Orders must satisfy total ordering laws: totality (either `x <= y` or `y <= x`), antisymmetry (if `x <= y` and `y <= x` then `x == y`), and transitivity (if `x <= y` and `y <= z` then `x <= z`)
- * - Orders can be composed using {@link combine} and {@link combineAll} to create multi-criteria comparisons
- * - Orders can be transformed using {@link mapInput} to compare values by extracting a comparable property
- * - Built-in orders exist for common types: {@link Number}, {@link String}, {@link Boolean}, {@link BigInt}, {@link Date}
- *
- * Common tasks:
- * - Creating custom orders → {@link make}
- * - Using built-in orders → {@link Number}, {@link String}, {@link Boolean}, {@link BigInt}, {@link Date}
- * - Combining multiple orders → {@link combine}, {@link combineAll}
- * - Transforming orders → {@link mapInput}
- * - Comparing values → {@link isLessThan}, {@link isGreaterThan}, {@link isLessThanOrEqualTo}, {@link isGreaterThanOrEqualTo}
- * - Finding min/max → {@link min}, {@link max}
- * - Clamping values → {@link clamp}, {@link isBetween}
- * - Ordering collections → {@link Array}, {@link Tuple}, {@link Struct}
- *
- * Gotchas:
- * - `Order.Number` treats all `NaN` values as equal and less than any other number
- * - `Order.make` uses reference equality (`===`) as a shortcut: if `self === that`, it returns `0` without calling the comparison function
- * - `Order.Array` compares arrays element-by-element, then by length if all elements are equal; `Order.all` only compares elements up to the shorter array's length
- * - `Order.Tuple` requires a fixed-length tuple with matching order types; `Order.Array` works with variable-length arrays
- * - `Order.min` and `Order.max` return the first argument when values are equal
- *
- * Quickstart:
- *
- * **Example** (Basic Usage)
+ * The `Order` module defines total orderings: pure comparison functions that
+ * decide whether one value is less than, equal to, or greater than another. An
+ * `Order<A>` returns a normalized {@link Ordering} (`-1`, `0`, or `1`), making
+ * it suitable for sorting, finding minimum and maximum values, range checks, and
+ * building ordered data structures.
+ *
+ * **Mental model**
+ *
+ * - An {@link Order} is a comparator with laws: totality, antisymmetry, and
+ *   transitivity. If those laws do not hold, sorting and range operations can
+ *   produce surprising results.
+ * - `-1` means the left value comes before the right value, `0` means they are
+ *   equal for this ordering, and `1` means the left value comes after the right
+ *   value.
+ * - Primitive orders such as {@link Number}, {@link String}, {@link Boolean},
+ *   {@link BigInt}, and {@link Date} are building blocks.
+ * - Use {@link mapInput} to compare larger values by a field or derived key.
+ * - Use {@link combine} or {@link combineAll} for tie-breaking, where the first
+ *   non-zero comparison result wins.
+ *
+ * **Common tasks**
+ *
+ * - Create a custom order from a comparison function with {@link make}.
+ * - Sort or compare using built-in orders such as {@link Number} and
+ *   {@link String}.
+ * - Compare records and tuples with {@link Struct} and {@link Tuple}.
+ * - Compare arrays lexicographically with {@link Array}.
+ * - Convert an order into predicates with {@link isLessThan},
+ *   {@link isGreaterThan}, {@link isLessThanOrEqualTo}, and
+ *   {@link isGreaterThanOrEqualTo}.
+ * - Select boundaries with {@link min}, {@link max}, {@link clamp}, and
+ *   {@link isBetween}.
+ *
+ * **Gotchas**
+ *
+ * - {@link make} returns `0` immediately when `self === that`; the custom
+ *   comparison function is not called for identical references.
+ * - {@link Number} treats all `NaN` values as equal to each other and less than
+ *   every non-`NaN` number.
+ * - {@link Array} compares elements first and length second. {@link Tuple}
+ *   compares a fixed number of positions.
+ * - {@link Struct} compares fields in the key order of the object passed to it,
+ *   so put the highest-priority fields first.
+ * - {@link min} and {@link max} return the first argument when two values
+ *   compare as equal.
+ *
+ * **Example** (Sorting by multiple fields)
  *
  * ```ts
- * import { Order } from "effect"
- *
- * const result = Order.Number(5, 10)
- * console.log(result) // -1 (5 is less than 10)
- *
- * const isLessThan = Order.isLessThan(Order.Number)(5, 10)
- * console.log(isLessThan) // true
+ * import { Array, Order } from "effect"
+ *
+ * interface User {
+ *   readonly name: string
+ *   readonly age: number
+ * }
+ *
+ * const byAge = Order.mapInput(Order.Number, (user: User) => user.age)
+ * const byName = Order.mapInput(Order.String, (user: User) => user.name)
+ * const byAgeThenName = Order.combine(byAge, byName)
+ *
+ * const users = [
+ *   { name: "Charlie", age: 30 },
+ *   { name: "Bob", age: 25 },
+ *   { name: "Alice", age: 30 }
+ * ]
+ *
+ * const sorted = Array.sort(users, byAgeThenName)
+ * console.log(sorted.map((user) => user.name))
+ * // ["Bob", "Alice", "Charlie"]
  * ```
  *
- * See also:
- * - {@link Ordering} - The result type of comparisons
- * - {@link Reducer} - For combining orders in collections
+ * **See also**
+ *
+ * - {@link Ordering} for the normalized comparison result type.
+ * - `Equivalence` for equality without less-than or greater-than.
+ * - {@link Reducer} for combining orders with reducer-style APIs.
  *
  * @since 2.0.0
  */
@@ -56,13 +85,12 @@ import * as Reducer from "./Reducer.js";
  *
  * **When to use**
  *
- * - When creating a custom order for a type that doesn't have a built-in order
+ * Use when when creating a custom order for a type that doesn't have a built-in order
  * - When you need fine-grained control over comparison logic
  * - When implementing orders for complex types
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Uses reference equality (`===`) as a shortcut: if `self === that`, returns `0` without calling the comparison function
  * - The comparison function should return `-1`, `0`, or `1` based on the comparison result
  * - The returned order satisfies total ordering laws if the comparison function does
@@ -82,8 +110,8 @@ import * as Reducer from "./Reducer.js";
  * console.log(byAge({ name: "Alice", age: 25 }, { name: "Bob", age: 30 })) // -1
  * ```
  *
- * @see {@link mapInput} - Transform an order by mapping the input type
- * @see {@link combine} - Combine multiple orders
+ * @see {@link mapInput} to transform an order by mapping the input type
+ * @see {@link combine} to combine multiple orders
  * @category constructors
  * @since 2.0.0
  */
@@ -91,17 +119,16 @@ export function make(compare) {
   return (self, that) => self === that ? 0 : compare(self, that);
 }
 /**
- * An `Order` instance for strings that compares them lexicographically using JavaScript's `<` operator.
+ * Order instance for strings that compares them lexicographically using JavaScript's `<` operator.
  *
  * **When to use**
  *
- * - When comparing strings alphabetically
+ * Use when when comparing strings alphabetically
  * - When sorting string collections
  * - As a base for creating orders on types containing strings
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Uses lexicographic (dictionary) ordering
  * - Empty string is less than any non-empty string
  * - Comparison is case-sensitive
@@ -116,24 +143,23 @@ export function make(compare) {
  * console.log(Order.String("apple", "apple")) // 0
  * ```
  *
- * @see {@link mapInput} - Use this order to compare objects by a string property
- * @see {@link Struct} - Combine with other orders for struct comparison
+ * @see {@link mapInput} to compare objects by a string property
+ * @see {@link Struct} to combine with other orders for struct comparison
  * @category instances
  * @since 4.0.0
  */
 export const String = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
 /**
- * An `Order` instance for numbers that compares them numerically.
+ * Order instance for numbers that compares them numerically.
  *
  * **When to use**
  *
- * - When comparing numbers for sorting or searching
+ * Use when when comparing numbers for sorting or searching
  * - As a base for creating orders on types containing numbers
  * - When implementing numeric comparisons in data structures
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - `0` is considered equal to `-0`
  * - All `NaN` values are considered equal to each other
  * - Any `NaN` is considered less than any non-NaN number
@@ -152,8 +178,8 @@ export const String = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * console.log(Order.Number(NaN, 1)) // -1
  * ```
  *
- * @see {@link mapInput} - Use this order to compare objects by a number property
- * @see {@link BigInt} - For bigint comparisons
+ * @see {@link mapInput} to compare objects by a number property
+ * @see {@link BigInt} for bigint comparisons
  * @category instances
  * @since 4.0.0
  */
@@ -164,17 +190,16 @@ export const Number = /*#__PURE__*/make((self, that) => {
   return self < that ? -1 : 1;
 });
 /**
- * An `Order` instance for booleans where `false` is considered less than `true`.
+ * Order instance for booleans where `false` is considered less than `true`.
  *
  * **When to use**
  *
- * - When comparing booleans for sorting or searching
+ * Use when when comparing booleans for sorting or searching
  * - As a base for creating orders on types containing booleans
  * - When implementing boolean-based comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - `false` is less than `true`
  * - Equal values return `0`
  *
@@ -188,23 +213,22 @@ export const Number = /*#__PURE__*/make((self, that) => {
  * console.log(Order.Boolean(true, true)) // 0
  * ```
  *
- * @see {@link mapInput} - Use this order to compare objects by a boolean property
+ * @see {@link mapInput} to compare objects by a boolean property
  * @category instances
  * @since 4.0.0
  */
 export const Boolean = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
 /**
- * An `Order` instance for bigints that compares them numerically.
+ * Order instance for bigints that compares them numerically.
  *
  * **When to use**
  *
- * - When comparing bigint values for sorting or searching
+ * Use when when comparing bigint values for sorting or searching
  * - As a base for creating orders on types containing bigints
  * - When working with large integers that exceed number precision
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Uses standard numeric comparison for bigint values
  * - Handles arbitrarily large integers
  *
@@ -218,8 +242,8 @@ export const Boolean = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * console.log(Order.BigInt(1n, 1n)) // 0
  * ```
  *
- * @see {@link Number} - For regular number comparisons
- * @see {@link mapInput} - Use this order to compare objects by a bigint property
+ * @see {@link Number} for regular number comparisons
+ * @see {@link mapInput} to compare objects by a bigint property
  * @category instances
  * @since 4.0.0
  */
@@ -229,13 +253,12 @@ export const BigInt = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  *
  * **When to use**
  *
- * - When you need descending order instead of ascending
+ * Use when when you need descending order instead of ascending
  * - When reversing an existing order without modifying the original
  * - When creating orders that compare in the opposite direction
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns a new order that swaps the arguments before comparison
  * - If the original order returns `-1`, the flipped order returns `1`, and vice versa
  * - Equal comparisons remain `0`
@@ -252,7 +275,7 @@ export const BigInt = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * console.log(flip(1, 1)) // 0
  * ```
  *
- * @see {@link combine} - Combine orders for multi-criteria comparison
+ * @see {@link combine} to combine orders for multi-criteria comparison
  * @category combinators
  * @since 4.0.0
  */
@@ -265,13 +288,12 @@ export function flip(O) {
  *
  * **When to use**
  *
- * - When you need multi-criteria comparison (e.g., sort by age, then by name)
+ * Use when when you need multi-criteria comparison (e.g., sort by age, then by name)
  * - When creating composite orders from simpler orders
  * - When implementing lexicographic ordering
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - First applies the first order; if the result is non-zero, returns that result
  * - If the first order returns `0` (equal), applies the second order
  * - Returns the first non-zero result, or `0` if both orders return `0`
@@ -299,8 +321,8 @@ export function flip(O) {
  * console.log(byAgeAndName(person1, person3)) // 1 (Alice (30) > Charlie (25))
  * ```
  *
- * @see {@link combineAll} - Combine multiple orders from a collection
- * @see {@link mapInput} - Transform orders to work with different types
+ * @see {@link combineAll} to combine multiple orders from a collection
+ * @see {@link mapInput} to transform orders to work with different types
  * @category combining
  * @since 2.0.0
  */
@@ -316,13 +338,12 @@ export const combine = /*#__PURE__*/dual(2, (self, that) => make((a1, a2) => {
  *
  * **When to use**
  *
- * - When you need an order that doesn't distinguish between values
+ * Use when when you need an order that doesn't distinguish between values
  * - As a default or fallback order when no meaningful comparison exists
  * - When implementing optional ordering where equality is sufficient
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Always returns `0` regardless of input values
  * - Useful as a neutral element in order composition
  *
@@ -338,7 +359,7 @@ export const combine = /*#__PURE__*/dual(2, (self, that) => make((a1, a2) => {
  * console.log(alwaysEqualOrder(1, 1)) // 0
  * ```
  *
- * @see {@link combine} - Combine with other orders
+ * @see {@link combine} to combine with other orders
  * @category constructors
  * @since 4.0.0
  */
@@ -351,13 +372,12 @@ export function alwaysEqual() {
  *
  * **When to use**
  *
- * - When you have a variable number of orders to combine
+ * Use when when you have a variable number of orders to combine
  * - When combining orders from a collection or array
  * - When implementing dynamic multi-criteria sorting
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Applies orders in iteration order
  * - Returns the first non-zero result from any order
  * - Returns `0` only if all orders return `0`
@@ -385,8 +405,8 @@ export function alwaysEqual() {
  * console.log(combinedOrder(person1, person2)) // -1 (Same age, Alice < Bob)
  * ```
  *
- * @see {@link combine} - Combine two orders
- * @see {@link makeReducer} - Create a reducer for combining orders
+ * @see {@link combine} to combine two orders
+ * @see {@link makeReducer} to create a reducer for combining orders
  * @category combining
  * @since 2.0.0
  */
@@ -408,13 +428,12 @@ export function combineAll(collection) {
  *
  * **When to use**
  *
- * - When you have an order for a property type and want to compare objects by that property
+ * Use when when you have an order for a property type and want to compare objects by that property
  * - When extracting a comparable value from a complex type
  * - When creating orders for types that contain comparable values
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Applies the mapping function to both values before comparison
  * - The mapping function should be pure and not have side effects
  * - Preserves the ordering properties of the original order
@@ -431,24 +450,23 @@ export function combineAll(collection) {
  * console.log(byLength("aa", "bb")) // 0
  * ```
  *
- * @see {@link combine} - Combine mapped orders for multi-criteria comparison
- * @see {@link Struct} - Create orders for structs with multiple fields
+ * @see {@link combine} to combine mapped orders for multi-criteria comparison
+ * @see {@link Struct} to create orders for structs with multiple fields
  * @category mapping
  * @since 2.0.0
  */
 export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((b1, b2) => self(f(b1), f(b2))));
 /**
- * An `Order` instance for `Date` objects that compares them chronologically by their timestamp.
+ * Order instance for `Date` objects that compares them chronologically by their timestamp.
  *
  * **When to use**
  *
- * - When comparing dates for sorting or searching
+ * Use when when comparing dates for sorting or searching
  * - As a base for creating orders on types containing dates
  * - When implementing time-based comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Compares dates by their underlying timestamp (milliseconds since epoch)
  * - Earlier dates are less than later dates
  * - Invalid dates are compared as if they were valid (uses `getTime()` result)
@@ -466,7 +484,7 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((b1, b2) => self(
  * console.log(Order.Date(date1, date1)) // 0
  * ```
  *
- * @see {@link mapInput} - Use this order to compare objects by a date property
+ * @see {@link mapInput} to compare objects by a date property
  * @category instances
  * @since 2.0.0
  */
@@ -476,13 +494,12 @@ export const Date = /*#__PURE__*/mapInput(Number, date => date.getTime());
  *
  * **When to use**
  *
- * - When comparing tuples with different types for each position
+ * Use when when comparing tuples with different types for each position
  * - When you need type-safe tuple ordering
  * - When working with fixed-length heterogeneous collections
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Compares tuples element-by-element using the corresponding order
  * - Stops at the first non-zero comparison result
  * - Requires tuples to have the same length as the order collection
@@ -500,7 +517,7 @@ export const Date = /*#__PURE__*/mapInput(Number, date => date.getTime());
  * console.log(tupleOrder([1, "a"], [1, "a"])) // 0
  * ```
  *
- * @see {@link Array} - Compare arrays with length consideration
+ * @see {@link Array} to compare arrays with length consideration
  * @category combinators
  * @since 4.0.0
  */
@@ -539,13 +556,12 @@ export {
  *
  * **When to use**
  *
- * - When comparing arrays of the same element type
+ * Use when when comparing arrays of the same element type
  * - When you want shorter arrays to be considered less than longer arrays
  * - When sorting collections of arrays
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Compares arrays element-by-element using the provided order
  * - Stops at the first non-zero comparison result
  * - If all elements are equal, shorter arrays are less than longer arrays
@@ -564,7 +580,7 @@ export {
  * console.log(arrayOrder([1, 2], [1, 2])) // 0
  * ```
  *
- * @see {@link Tuple} - Type-safe tuple ordering
+ * @see {@link Tuple} for type-safe tuple ordering
  * @category combinators
  * @since 4.0.0
  */
@@ -574,13 +590,12 @@ Array_ as Array };
  *
  * **When to use**
  *
- * - When comparing objects with multiple properties
+ * Use when when comparing objects with multiple properties
  * - When you need multi-field comparison for structs
  * - When creating orders for complex data types
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Compares structs field-by-field in the order of keys in the fields object
  * - Stops at the first non-zero comparison result
  * - Returns `0` only if all fields are equal
@@ -605,8 +620,8 @@ Array_ as Array };
  * console.log(personOrder(person1, person1)) // 0
  * ```
  *
- * @see {@link combine} - Combine orders manually
- * @see {@link mapInput} - Extract and compare by a single property
+ * @see {@link combine} to combine orders manually
+ * @see {@link mapInput} to extract and compare by a single property
  * @category combinators
  * @since 4.0.0
  */
@@ -623,17 +638,16 @@ export function Struct(fields) {
   });
 }
 /**
- * Tests whether one value is strictly less than another according to the given order.
+ * Checks whether one value is strictly less than another according to the given order.
  *
  * **When to use**
  *
- * - When you need a boolean predicate instead of an ordering result
+ * Use when when you need a boolean predicate instead of an ordering result
  * - When checking if a value is less than another in conditional logic
  * - When implementing range checks or comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns `true` if the order returns `-1` (first value is less than second)
  * - Returns `false` for equal or greater values
  * - Supports curried and uncurried call styles
@@ -650,24 +664,23 @@ export function Struct(fields) {
  * console.log(isLessThanNumber(1, 1)) // false
  * ```
  *
- * @see {@link isLessThanOrEqualTo} - Non-strict less than or equal
- * @see {@link isGreaterThan} - Strict greater than
+ * @see {@link isLessThanOrEqualTo} for non-strict less than or equal
+ * @see {@link isGreaterThan} for strict greater than
  * @category predicates
  * @since 4.0.0
  */
 export const isLessThan = O => dual(2, (self, that) => O(self, that) === -1);
 /**
- * Tests whether one value is strictly greater than another according to the given order.
+ * Checks whether one value is strictly greater than another according to the given order.
  *
  * **When to use**
  *
- * - When you need a boolean predicate instead of an ordering result
+ * Use when when you need a boolean predicate instead of an ordering result
  * - When checking if a value is greater than another in conditional logic
  * - When implementing range checks or comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns `true` if the order returns `1` (first value is greater than second)
  * - Returns `false` for equal or lesser values
  * - Supports curried and uncurried call styles
@@ -684,24 +697,23 @@ export const isLessThan = O => dual(2, (self, that) => O(self, that) === -1);
  * console.log(isGreaterThanNumber(1, 1)) // false
  * ```
  *
- * @see {@link isGreaterThanOrEqualTo} - Non-strict greater than or equal
- * @see {@link isLessThan} - Strict less than
+ * @see {@link isGreaterThanOrEqualTo} for non-strict greater than or equal
+ * @see {@link isLessThan} for strict less than
  * @category predicates
  * @since 4.0.0
  */
 export const isGreaterThan = O => dual(2, (self, that) => O(self, that) === 1);
 /**
- * Tests whether one value is less than or equal to another according to the given order.
+ * Checks whether one value is less than or equal to another according to the given order.
  *
  * **When to use**
  *
- * - When you need a boolean predicate for non-strict comparison
+ * Use when when you need a boolean predicate for non-strict comparison
  * - When checking if a value is within a range (inclusive lower bound)
  * - When implementing inclusive comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns `true` if the order returns `-1` or `0` (less than or equal)
  * - Returns `false` only if the order returns `1` (greater than)
  * - Supports curried and uncurried call styles
@@ -718,24 +730,23 @@ export const isGreaterThan = O => dual(2, (self, that) => O(self, that) === 1);
  * console.log(isLessThanOrEqualToNumber(2, 1)) // false
  * ```
  *
- * @see {@link isLessThan} - Strict less than
- * @see {@link isGreaterThan} - Strict greater than
+ * @see {@link isLessThan} for strict less than
+ * @see {@link isGreaterThan} for strict greater than
  * @category predicates
  * @since 4.0.0
  */
 export const isLessThanOrEqualTo = O => dual(2, (self, that) => O(self, that) !== 1);
 /**
- * Tests whether one value is greater than or equal to another according to the given order.
+ * Checks whether one value is greater than or equal to another according to the given order.
  *
  * **When to use**
  *
- * - When you need a boolean predicate for non-strict comparison
+ * Use when when you need a boolean predicate for non-strict comparison
  * - When checking if a value is within a range (inclusive upper bound)
  * - When implementing inclusive comparisons
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns `true` if the order returns `1` or `0` (greater than or equal)
  * - Returns `false` only if the order returns `-1` (less than)
  * - Supports curried and uncurried call styles
@@ -752,8 +763,8 @@ export const isLessThanOrEqualTo = O => dual(2, (self, that) => O(self, that) !=
  * console.log(isGreaterThanOrEqualToNumber(1, 2)) // false
  * ```
  *
- * @see {@link isGreaterThan} - Strict greater than
- * @see {@link isLessThanOrEqualTo} - Less than or equal
+ * @see {@link isGreaterThan} for strict greater than
+ * @see {@link isLessThanOrEqualTo} for less than or equal
  * @category predicates
  * @since 4.0.0
  */
@@ -763,13 +774,12 @@ export const isGreaterThanOrEqualTo = O => dual(2, (self, that) => O(self, that)
  *
  * **When to use**
  *
- * - When you need to find the smaller of two values
+ * Use when when you need to find the smaller of two values
  * - When implementing min/max operations
  * - When selecting values based on ordering
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns the value that compares as less than or equal to the other
  * - If values are equal, returns the first argument
  * - Supports curried and uncurried call styles
@@ -786,8 +796,8 @@ export const isGreaterThanOrEqualTo = O => dual(2, (self, that) => O(self, that)
  * console.log(minNumber(1, 1)) // 1
  * ```
  *
- * @see {@link max} - Maximum of two values
- * @see {@link clamp} - Clamp a value between min and max
+ * @see {@link max} for the maximum of two values
+ * @see {@link clamp} to clamp a value between min and max
  * @category comparisons
  * @since 2.0.0
  */
@@ -797,13 +807,12 @@ export const min = O => dual(2, (self, that) => self === that || O(self, that) <
  *
  * **When to use**
  *
- * - When you need to find the larger of two values
+ * Use when when you need to find the larger of two values
  * - When implementing min/max operations
  * - When selecting values based on ordering
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns the value that compares as greater than or equal to the other
  * - If values are equal, returns the first argument
  * - Supports curried and uncurried call styles
@@ -820,24 +829,23 @@ export const min = O => dual(2, (self, that) => self === that || O(self, that) <
  * console.log(maxNumber(1, 1)) // 1
  * ```
  *
- * @see {@link min} - Minimum of two values
- * @see {@link clamp} - Clamp a value between min and max
+ * @see {@link min} for the minimum of two values
+ * @see {@link clamp} to clamp a value between min and max
  * @category comparisons
  * @since 2.0.0
  */
 export const max = O => dual(2, (self, that) => self === that || O(self, that) > -1 ? self : that);
 /**
- * Clamps a value between a minimum and a maximum according to the given order.
+ * Restricts a value between a minimum and a maximum according to the given order.
  *
  * **When to use**
  *
- * - When you need to restrict a value to a specific range
+ * Use when when you need to restrict a value to a specific range
  * - When implementing bounds checking and normalization
  * - When ensuring values stay within valid ranges
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns the value if it's between minimum and maximum (inclusive)
  * - Returns minimum if the value is less than minimum
  * - Returns maximum if the value is greater than maximum
@@ -856,25 +864,24 @@ export const max = O => dual(2, (self, that) => self === that || O(self, that) >
  * console.log(clamp(6)) // 5
  * ```
  *
- * @see {@link min} - Minimum of two values
- * @see {@link max} - Maximum of two values
- * @see {@link isBetween} - Check if a value is within a range
+ * @see {@link min} for the minimum of two values
+ * @see {@link max} for the maximum of two values
+ * @see {@link isBetween} to check if a value is within a range
  * @category comparisons
  * @since 2.0.0
  */
 export const clamp = O => dual(2, (self, options) => min(O)(options.maximum, max(O)(options.minimum, self)));
 /**
- * Tests whether a value is between a minimum and a maximum (inclusive) according to the given order.
+ * Checks whether a value is between a minimum and a maximum (inclusive) according to the given order.
  *
  * **When to use**
  *
- * - When validating that a value is within a valid range
+ * Use when when validating that a value is within a valid range
  * - When implementing range checks for bounds validation
  * - When filtering or selecting values within a range
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs
  * - Returns `true` if the value is greater than or equal to minimum and less than or equal to maximum
  * - Returns `false` if the value is outside the range
  * - Supports curried and uncurried call styles
@@ -894,9 +901,9 @@ export const clamp = O => dual(2, (self, options) => min(O)(options.maximum, max
  * console.log(betweenNumber(11, { minimum: 1, maximum: 10 })) // false
  * ```
  *
- * @see {@link clamp} - Clamp a value to a range
- * @see {@link isLessThanOrEqualTo} - Less than or equal check
- * @see {@link isGreaterThanOrEqualTo} - Greater than or equal check
+ * @see {@link clamp} to clamp a value to a range
+ * @see {@link isLessThanOrEqualTo} for less than or equal check
+ * @see {@link isGreaterThanOrEqualTo} for greater than or equal check
  * @category predicates
  * @since 4.0.0
  */
@@ -906,7 +913,7 @@ export const isBetween = O => dual(2, (self, options) => !isLessThan(O)(self, op
  *
  * **When to use**
  *
- * - When you need to combine multiple orders from a collection using reducer patterns
+ * Use when when you need to combine multiple orders from a collection using reducer patterns
  * - When implementing fold operations over collections of orders
  * - When working with reducers that operate on orders
  *
@@ -929,9 +936,9 @@ export const isBetween = O => dual(2, (self, options) => !isLessThan(O)(self, op
  * console.log(combined(1, 2)) // -1 (uses first order)
  * ```
  *
- * @see {@link combine} - Combine two orders
- * @see {@link combineAll} - Combine multiple orders
- * @see {@link Reducer} - Reducer type for collection operations
+ * @see {@link combine} to combine two orders
+ * @see {@link combineAll} to combine multiple orders
+ * @see {@link Reducer} for reducing orders as a collection operation
  * @category utils
  * @since 4.0.0
  */