diff options
| author | Louis Pilfold <louis@lpil.uk> | 2024-05-24 22:10:38 +0100 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2024-05-24 22:11:03 +0100 |
| commit | 99643d8fd40d44b828d8f3298d5282e356709f41 (patch) | |
| tree | 9531647e58066c8d6d494a77f6f79dffd6cda4d1 | |
| parent | d8f046a674197b41e409fec0522a5f6d2d4c7a6d (diff) | |
| download | gleam_stdlib-99643d8fd40d44b828d8f3298d5282e356709f41.tar.gz gleam_stdlib-99643d8fd40d44b828d8f3298d5282e356709f41.zip | |
Deprecate min and max
| -rw-r--r-- | CHANGELOG.md | 4 | ||||
| -rw-r--r-- | src/gleam/order.gleam | 22 |
2 files changed, 8 insertions, 18 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e0e6e6..7c96745 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## v0.39.0 - Unreleased + +- The `min` and `max` functions of the `order` module have been deprecated. + ## v0.38.0 - 2024-05-24 - The `set` module gains the `is_subset`, `is_disjoint`, and `symmetric_difference` functions diff --git a/src/gleam/order.gleam b/src/gleam/order.gleam index e36e1e7..b9b709d 100644 --- a/src/gleam/order.gleam +++ b/src/gleam/order.gleam @@ -84,15 +84,8 @@ pub fn compare(a: Order, with b: Order) -> Order { } } -/// Returns the largest of two orders given that `Gt > Eq > Lt`. -/// -/// ## Examples -/// -/// ```gleam -/// max(Eq, Lt) -/// // -> Eq -/// ``` -/// +@deprecated("This function is being removed as it is not useful. +The name may be used for a more helpful function in future.") pub fn max(a: Order, b: Order) -> Order { case a, b { Gt, _ -> Gt @@ -101,15 +94,8 @@ pub fn max(a: Order, b: Order) -> Order { } } -/// Returns the smallest of two orders given that `Gt > Eq > Lt`. -/// -/// ## Examples -/// -/// ```gleam -/// min(Eq, Lt) -/// // -> Lt -/// ``` -/// +@deprecated("This function is being removed as it is not useful. +The name may be used for a more helpful function in future.") pub fn min(a: Order, b: Order) -> Order { case a, b { Lt, _ -> Lt |