diff options
| -rw-r--r-- | src/gleam/order.gleam | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/gleam/order.gleam b/src/gleam/order.gleam index 979c8c2..77ad033 100644 --- a/src/gleam/order.gleam +++ b/src/gleam/order.gleam @@ -84,7 +84,7 @@ pub fn compare(a: Order, with b: Order) -> Order { } } -/// Returns the largest of two orders. +/// Returns the largest of two orders given that `Gt > Eq > Lt`. /// /// ## Examples /// @@ -101,7 +101,7 @@ pub fn max(a: Order, b: Order) -> Order { } } -/// Returns the smallest of two orders. +/// Returns the smallest of two orders given that `Gt > Eq > Lt`. /// /// ## Examples /// |