aboutsummaryrefslogtreecommitdiff
path: root/docs/booleans.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-11-09 15:11:11 -0500
committerBruce Hill <bruce@bruce-hill.com>2024-11-09 15:11:11 -0500
commit7a4f2e73addf6dfcde2a6b17b62b961608e556a0 (patch)
treec03e4758e5725a4a6d352f5bb7d323796ed99947 /docs/booleans.md
parent5d35f286336878a3529dabdb3f7800b6f84712eb (diff)
Rename `from_text()` to `parse()`
Diffstat (limited to 'docs/booleans.md')
-rw-r--r--docs/booleans.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/booleans.md b/docs/booleans.md
index 4f44931a..80de6fa6 100644
--- a/docs/booleans.md
+++ b/docs/booleans.md
@@ -7,7 +7,7 @@ Boolean values have the type `Bool` and can be either `yes` ("true") or `no`
This documentation provides details on boolean functions available in the API.
-## `from_text`
+## `parse`
**Description:**
Converts a string representation of a boolean value into a boolean. Acceptable
@@ -16,7 +16,7 @@ boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`,
**Signature:**
```tomo
-func from_text(text: Text -> Bool?)
+func parse(text: Text -> Bool?)
```
**Parameters:**
@@ -28,10 +28,10 @@ func from_text(text: Text -> Bool?)
**Example:**
```tomo
->> Bool.from_text("yes")
+>> Bool.parse("yes")
= yes?
->> Bool.from_text("no")
+>> Bool.parse("no")
= no?
->> Bool.from_text("???")
+>> Bool.parse("???")
= !Bool
```