Rename result.recover to result.try_recover

Author: giacomocavalieri

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-- The `result` module gains the `recover` function.
+- The `result` module gains the `try_recover` function.
 
 ## v0.29.1 - 2023-06-01
 

src/gleam/result.gleam

@@ -458,21 +458,21 @@ pub fn values(results: List(Result(a, e))) -> List(a) {
 /// ## Examples
 ///
 /// ```gleam
-/// > Ok(1) |> recover(with: fn(_) { Error("failed to recover") })
+/// > Ok(1) |> try_recover(with: fn(_) { Error("failed to recover") })
 /// Ok(1)
 /// ```
 ///
 /// ```gleam
-/// > Error(1) |> recover(with: fn(error) { Ok(error + 1) })
+/// > Error(1) |> try_recover(with: fn(error) { Ok(error + 1) })
 /// Ok(2)
 /// ```
 ///
 /// ```gleam
-/// > Error(1) |> recover(with: fn(error) { Error("failed to recover") })
+/// > Error(1) |> try_recover(with: fn(error) { Error("failed to recover") })
 /// Error("failed to recover")
 /// ```
 ///
-pub fn recover(
+pub fn try_recover(
   result: Result(a, e),
   with fun: fn(e) -> Result(a, f),
 ) -> Result(a, f) {

test/gleam/result_test.gleam

@@ -250,16 +250,16 @@ pub fn values_test() {
   |> should.equal([1, 3])
 }
 
-pub fn recover_test() {
+pub fn try_recover_test() {
   Ok(1)
-  |> result.recover(fn(_) { panic })
+  |> result.try_recover(fn(_) { panic })
   |> should.equal(Ok(1))
 
   Error(1)
-  |> result.recover(fn(n) { Ok(n + 1) })
+  |> result.try_recover(fn(n) { Ok(n + 1) })
   |> should.equal(Ok(2))
 
   Error(1)
-  |> result.recover(fn(_) { Error("failed to recover") })
+  |> result.try_recover(fn(_) { Error("failed to recover") })
   |> should.equal(Error("failed to recover"))
 }