From 67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 Mon Sep 17 00:00:00 2001
From: Bruce Hill <bruce@bruce-hill.com>
Date: Mon, 19 Aug 2024 00:23:02 -0400
Subject: Move docs into one folder

---
 docs/booleans.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/booleans.md

(limited to 'docs/booleans.md')

diff --git a/docs/booleans.md b/docs/booleans.md
new file mode 100644
index 00000000..7d2c29a4
--- /dev/null
+++ b/docs/booleans.md
@@ -0,0 +1,65 @@
+# 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)
+```
-- 
cgit v1.2.3