From 68c3c2ec7fad21cf65f544fc0c4dc30519bd603c Mon Sep 17 00:00:00 2001
From: Louis Pilfold <louis@lpil.uk>
Date: Sat, 21 Jan 2023 13:28:32 +0000
Subject: Rework bool.guard

---
 src/gleam/bool.gleam | 54 ++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 42 insertions(+), 12 deletions(-)

(limited to 'src')

diff --git a/src/gleam/bool.gleam b/src/gleam/bool.gleam
index 2d4b74d..5586153 100644
--- a/src/gleam/bool.gleam
+++ b/src/gleam/bool.gleam
@@ -326,33 +326,63 @@ pub fn to_string(bool: Bool) -> String {
 
 /// Run a callback function if the given bool is `True`, otherwise return a
 /// default value.
+/// 
+/// With a `use` expression this function can simulate the early-return pattern
+/// found in some other programming languages.
 ///
-/// This function is suitable for `use` expressions.
+/// In a procedural language:
 ///
-/// ## Examples
+/// ```js
+/// if (predicate) return value;
+/// // ...
+/// ```
+///
+/// In Gleam with a `use` expression:
 ///
 /// ```gleam
-/// > let name = "Kamaka"
-/// > use <- guard(name != "", or: "Welcome!")
-/// > "Hello, " <> name
-/// "Hello, Kamaka"
+/// use <- guard(when: predicate, return: value)
+/// // ...
 /// ```
 ///
+/// Like everything in Gleam `use` is an expression, so it short circuits the
+/// current block, not the entire function. As a result you can assign the value
+/// to a variable:
+///
+/// ```gleam
+/// let x = {
+///   use <- guard(when: predicate, return: value)
+///   // ...
+/// }
+/// ```
+///
+/// Note that unlike in procedural languages the `return` value is evaluated
+/// even when the predicate is `False`, so it is advisable not to perform
+/// expensive computation there.
+///
+///
+/// ## Examples
+///
 /// ```gleam
 /// > let name = ""
-/// > use <- guard(name != "", or: "Welcome!")
+/// > use <- guard(when: name == "", return: "Welcome!")
 /// > "Hello, " <> name
 /// "Welcome!"
 /// ```
 ///
+/// ```gleam
+/// > let name = "Kamaka"
+/// > use <- guard(when: name == "", return: "Welcome!")
+/// > "Hello, " <> name
+/// "Hello, Kamaka"
+/// ```
 ///
 pub fn guard(
-  requirement: Bool,
-  or alternative: t,
-  then consequence: fn() -> t,
+  when requirement: Bool,
+  return consequence: t,
+  otherwise alternative: fn() -> t,
 ) -> t {
   case requirement {
-    True -> consequence()
-    False -> alternative
+    True -> consequence
+    False -> alternative()
   }
 }
-- 
cgit v1.2.3