From 2f5aef226f77db0c924f14d499fa73d2cf0dd872 Mon Sep 17 00:00:00 2001
From: Giacomo Cavalieri <giacomo.cavalieri@icloud.com>
Date: Thu, 22 Jun 2023 23:29:47 +0200
Subject: Add description of `Order` ordering

---
 src/gleam/order.gleam | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src')

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
 ///
-- 
cgit v1.2.3