aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Rothuis <alex.rothuis@gmail.com>2022-11-02 18:21:24 +0100
committerLouis Pilfold <louis@lpil.uk>2022-11-06 16:45:54 +0000
commitaef5695dc4bcbf9aad4326f219ca32417a641191 (patch)
tree3ed367362193521afd3afdf31143942a4701d2c0
parent65448a38bc5137e8cd7f10782bbe8d7435d27c5d (diff)
downloadgleam_stdlib-aef5695dc4bcbf9aad4326f219ca32417a641191.tar.gz
gleam_stdlib-aef5695dc4bcbf9aad4326f219ca32417a641191.zip
Improve bool and/or docs
Boolean operator functions do not short circuit
-rw-r--r--src/gleam/bool.gleam4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/gleam/bool.gleam b/src/gleam/bool.gleam
index e4a12a3..05092f5 100644
--- a/src/gleam/bool.gleam
+++ b/src/gleam/bool.gleam
@@ -8,7 +8,7 @@
import gleam/order.{Order}
-/// Returns the and of two bools.
+/// Returns the and of two bools, but it evaluates both arguments.
///
/// It's the function equivalent of the `&&` operator.
/// This function is useful in higher order functions or pipes.
@@ -29,7 +29,7 @@ pub fn and(a: Bool, b: Bool) -> Bool {
a && b
}
-/// Returns the or of two bools.
+/// Returns the or of two bools, but it evaluates both arguments.
///
/// It's the function equivalent of the `||` operator.
/// This function is useful in higher order functions or pipes.