Skip to content

Commit 2f5aef2

Browse files
giacomocavalierilpil
authored andcommitted
Add description of Order ordering
1 parent 72f4541 commit 2f5aef2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/gleam/order.gleam

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ pub fn compare(a: Order, with b: Order) -> Order {
8484
}
8585
}
8686

87-
/// Returns the largest of two orders.
87+
/// Returns the largest of two orders given that `Gt > Eq > Lt`.
8888
///
8989
/// ## Examples
9090
///
@@ -101,7 +101,7 @@ pub fn max(a: Order, b: Order) -> Order {
101101
}
102102
}
103103

104-
/// Returns the smallest of two orders.
104+
/// Returns the smallest of two orders given that `Gt > Eq > Lt`.
105105
///
106106
/// ## Examples
107107
///

0 commit comments

Comments
 (0)