v0.47.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.47.0 - 2024-12-10
+
+- The `compare` and `to_string` functions from the `gleam/bool` module have been
+  deprecated.
+
 ## v0.46.0 - 2024-12-08
 
 - Improved the performance of comparing two `Dict`s of equal size on the

gleam.toml

@@ -1,5 +1,5 @@
 name = "gleam_stdlib"
-version = "0.46.0"
+version = "0.47.0"
 gleam = ">= 0.32.0"
 licences = ["Apache-2.0"]
 description = "A standard library for the Gleam programming language"

src/gleam/bool.gleam

@@ -192,17 +192,7 @@ pub fn exclusive_nor(a: Bool, b: Bool) -> Bool {
   a == b
 }
 
-/// Compares two bools and returns the first value's `Order` to the second.
-///
-/// ## Examples
-///
-/// ```gleam
-/// import gleam/order
-///
-/// compare(True, False)
-/// // -> order.Gt
-/// ```
-///
+@deprecated("Please use a case expression to get the behaviour you desire")
 pub fn compare(a: Bool, with b: Bool) -> Order {
   case a, b {
     True, True -> order.Eq
@@ -212,20 +202,7 @@ pub fn compare(a: Bool, with b: Bool) -> Order {
   }
 }
 
-/// Returns a numeric representation of the given bool.
-///
-/// ## Examples
-///
-/// ```gleam
-/// to_int(True)
-/// // -> 1
-/// ```
-///
-/// ```gleam
-/// to_int(False)
-/// // -> 0
-/// ```
-///
+@deprecated("Please use a case expression to get the behaviour you desire")
 pub fn to_int(bool: Bool) -> Int {
   case bool {
     False -> 0