aboutsummaryrefslogtreecommitdiff
path: root/api/booleans.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-08-19 00:23:02 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-08-19 00:23:02 -0400
commit67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 (patch)
tree3f9d28687b6ac824b5676c963ef9964ac4857c4a /api/booleans.md
parent8363d53bd27c621cb342fea15736a3b11231f2a4 (diff)
Move docs into one folder
Diffstat (limited to 'api/booleans.md')
-rw-r--r--api/booleans.md65
1 files changed, 0 insertions, 65 deletions
diff --git a/api/booleans.md b/api/booleans.md
deleted file mode 100644
index 7d2c29a4..00000000
--- a/api/booleans.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Boolean Values
-
-Boolean values have the type `Bool` and can be either `yes` ("true") or `no`
-("false").
-
-# Boolean Functions
-
-This documentation provides details on boolean functions available in the API.
-
-## `from_text`
-
-**Description:**
-Converts a string representation of a boolean value into a boolean. Acceptable
-boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`,
-`true`/`false`, `on`/`off`.
-
-**Usage:**
-```tomo
-from_text(text: Text, success: Bool = !&Bool) -> Bool
-```
-
-**Parameters:**
-
-- `text`: The string containing the boolean value.
-- `success`: If provided, this boolean value reference will be set to `yes` if the given text is a recognizable boolean value or `no` otherwise.
-
-**Returns:**
-`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
-
-**Example:**
-```tomo
->> Bool.from_text("yes")
-= yes
->> Bool.from_text("no")
-= no
->> success := yes
->> Bool.from_text("???", &success)
-= no
->> success
-= no
-```
-
----
-
-## `random`
-
-**Description:**
-Generates a random boolean value based on a specified probability.
-
-**Usage:**
-```tomo
-random(p: Float = 0.5) -> Bool
-```
-
-**Parameters:**
-
-- `p`: The probability (between `0` and `1`) of returning `yes`. Default is `0.5`.
-
-**Returns:**
-`yes` with probability `p`, and `no` with probability `1 - p`.
-
-**Example:**
-```tomo
->> Bool.random(70%) // yes (with 70% probability)
-```