diff options
| author | Giacomo Cavalieri <giacomo.cavalieri@icloud.com> | 2023-06-22 23:29:47 +0200 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2023-06-22 23:24:25 +0100 |
| commit | 2f5aef226f77db0c924f14d499fa73d2cf0dd872 (patch) | |
| tree | 517cb636462ced19a5355d41606752d6f8d8318a | |
| parent | 72f45419de67adfb9acc517c7510859592281f4a (diff) | |
| download | gleam_stdlib-2f5aef226f77db0c924f14d499fa73d2cf0dd872.tar.gz gleam_stdlib-2f5aef226f77db0c924f14d499fa73d2cf0dd872.zip | |
Add description of `Order` ordering
| -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 /// |