diff options
Diffstat (limited to 'docs/booleans.md')
| -rw-r--r-- | docs/booleans.md | 30 |
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) |