aboutsummaryrefslogtreecommitdiff
path: root/docs/booleans.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
commit67fd3c725e6511adf70345f0733ec0b948477a11 (patch)
tree913d9f30d8ce3614a9ae3715281f8804323b24ff /docs/booleans.md
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'docs/booleans.md')
-rw-r--r--docs/booleans.md30
1 files changed, 2 insertions, 28 deletions
diff --git a/docs/booleans.md b/docs/booleans.md
index 8961091a..a3ad22d0 100644
--- a/docs/booleans.md
+++ b/docs/booleans.md
@@ -3,32 +3,6 @@
Boolean values have the type `Bool` and can be either `yes` ("true") or `no`
("false").
-## Boolean Functions
+# API
-This documentation provides details on boolean functions available in the API.
-
-- [`func parse(text: Text -> Bool?)`](#parse)
-
-### `parse`
-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`.
-
-```tomo
-func parse(text: Text -> Bool?)
-```
-
-- `text`: The string containing the boolean value.
-
-**Returns:**
-`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
-
-**Example:**
-```tomo
->> Bool.parse("yes")
-= yes : Bool?
->> Bool.parse("no")
-= no : Bool?
->> Bool.parse("???")
-= none : Bool?
-```
+[API documentation](../api/booleans.md)