aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlex Rothuis <alex.rothuis@gmail.com>2022-11-02 18:18:04 +0100
committerLouis Pilfold <louis@lpil.uk>2022-11-06 16:45:54 +0000
commit65448a38bc5137e8cd7f10782bbe8d7435d27c5d (patch)
tree09cb0958aa20d50e8a0eff5d8845c58f5c51c4c5 /src
parent0e14d0439bbd798656c9f161ce0fcd49b5bc12d3 (diff)
downloadgleam_stdlib-65448a38bc5137e8cd7f10782bbe8d7435d27c5d.tar.gz
gleam_stdlib-65448a38bc5137e8cd7f10782bbe8d7435d27c5d.zip
Fix documentation for bool and float function operators
Diffstat (limited to 'src')
-rw-r--r--src/gleam/bool.gleam10
-rw-r--r--src/gleam/float.gleam2
2 files changed, 3 insertions, 9 deletions
diff --git a/src/gleam/bool.gleam b/src/gleam/bool.gleam
index d55de8a..e4a12a3 100644
--- a/src/gleam/bool.gleam
+++ b/src/gleam/bool.gleam
@@ -22,10 +22,7 @@ import gleam/order.{Order}
/// > and(False, True)
/// False
///
-/// > True |> and(_, True)
-/// True
-///
-/// > False |> and(True, _)
+/// > False |> and(True)
/// False
/// ```
pub fn and(a: Bool, b: Bool) -> Bool {
@@ -46,10 +43,7 @@ pub fn and(a: Bool, b: Bool) -> Bool {
/// > or(False, True)
/// True
///
-/// > False |> or(_, False)
-/// False
-///
-/// > False |> or(True, _)
+/// > False |> or(True)
/// True
/// ```
pub fn or(a: Bool, b: Bool) -> Bool {
diff --git a/src/gleam/float.gleam b/src/gleam/float.gleam
index e6133fa..3f6e0de 100644
--- a/src/gleam/float.gleam
+++ b/src/gleam/float.gleam
@@ -479,7 +479,7 @@ pub fn multiply(a: Float, b: Float) -> Float {
a *. b
}
-/// Subtracts a float subtrahend from a float minuend.gleam/base
+/// Subtracts one float from another.
///
/// It's the function equivalent of the `-.` operator.
/// This function is useful in higher order functions or pipes.