diff options
| author | Giacomo Cavalieri <giacomo.cavalieri@icloud.com> | 2023-12-31 22:19:46 +0100 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2024-01-02 17:08:28 +0000 |
| commit | da08d59a184f22891d55a29458fd1f59c0b4d91e (patch) | |
| tree | e03ddb0126f01ceca923b7f58eed6a3c536183f6 /src | |
| parent | 780160c2cacc9e09070323bf6fcc8246a527bf38 (diff) | |
| download | gleam_stdlib-da08d59a184f22891d55a29458fd1f59c0b4d91e.tar.gz gleam_stdlib-da08d59a184f22891d55a29458fd1f59c0b4d91e.zip | |
order doc examples
Diffstat (limited to 'src')
| -rw-r--r-- | src/gleam/order.gleam | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/src/gleam/order.gleam b/src/gleam/order.gleam index 12ce011..ad25c94 100644 --- a/src/gleam/order.gleam +++ b/src/gleam/order.gleam @@ -18,18 +18,18 @@ pub type Order { /// ## Examples /// /// ```gleam -/// > negate(Lt) -/// Gt +/// negate(Lt) +/// // -> Gt /// ``` /// /// ```gleam -/// > negate(Eq) -/// Eq +/// negate(Eq) +/// // -> Eq /// ``` /// /// ```gleam -/// > negate(Lt) -/// Gt +/// negate(Lt) +/// // -> Gt /// ``` /// pub fn negate(order: Order) -> Order { @@ -45,18 +45,18 @@ pub fn negate(order: Order) -> Order { /// ## Examples /// /// ```gleam -/// > to_int(Lt) -/// -1 +/// to_int(Lt) +/// // -> -1 /// ``` /// /// ```gleam -/// > to_int(Eq) -/// 0 +/// to_int(Eq) +/// // -> 0 /// ``` /// /// ```gleam -/// > to_int(Gt) -/// 1 +/// to_int(Gt) +/// // -> 1 /// ``` /// pub fn to_int(order: Order) -> Int { @@ -72,8 +72,8 @@ pub fn to_int(order: Order) -> Int { /// ## Examples /// /// ```gleam -/// > compare(Eq, with: Lt) -/// Gt +/// compare(Eq, with: Lt) +/// // -> Gt /// ``` /// pub fn compare(a: Order, with b: Order) -> Order { @@ -89,8 +89,8 @@ pub fn compare(a: Order, with b: Order) -> Order { /// ## Examples /// /// ```gleam -/// > max(Eq, Lt) -/// Eq +/// max(Eq, Lt) +/// // -> Eq /// ``` /// pub fn max(a: Order, b: Order) -> Order { @@ -106,8 +106,8 @@ pub fn max(a: Order, b: Order) -> Order { /// ## Examples /// /// ```gleam -/// > min(Eq, Lt) -/// Lt +/// min(Eq, Lt) +/// // -> Lt /// ``` /// pub fn min(a: Order, b: Order) -> Order { @@ -124,8 +124,10 @@ pub fn min(a: Order, b: Order) -> Order { /// ## Examples /// /// ```gleam -/// > list.sort([1, 5, 4], by: reverse(int.compare)) -/// [5, 4, 1] +/// import gleam/int +/// import gleam/list +/// list.sort([1, 5, 4], by: reverse(int.compare)) +/// // -> [5, 4, 1] /// ``` /// pub fn reverse(orderer: fn(a, a) -> Order) -> fn(a, a) -> Order { |