diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-04-19 14:35:34 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-04-19 14:35:34 -0400 |
| commit | 67fd3c725e6511adf70345f0733ec0b948477a11 (patch) | |
| tree | 913d9f30d8ce3614a9ae3715281f8804323b24ff /man/man3/tomo-Bool.parse.3 | |
| parent | 0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff) | |
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Bool.parse.3')
| -rw-r--r-- | man/man3/tomo-Bool.parse.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/man/man3/tomo-Bool.parse.3 b/man/man3/tomo-Bool.parse.3 new file mode 100644 index 00000000..6c722b99 --- /dev/null +++ b/man/man3/tomo-Bool.parse.3 @@ -0,0 +1,38 @@ +'\" t +.\" Copyright (c) 2025 Bruce Hill +.\" All rights reserved. +.\" +.TH Bool.parse 3 2025-04-19T14:30:40.359614 "Tomo man-pages" +.SH NAME +Bool.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`. + +.SH LIBRARY +Tomo Standard Library +.SH SYNOPSIS +.nf +.BI "Bool.parse : func(text: Text -> Bool?)" +.fi + +.SH 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`. + + +.TS +allbox; +lb lb lbx lb +l l l l. +Name Type Description Default +text Text The string containing the boolean value. - +.TE +.SH RETURN +`yes` if the string matches a recognized truthy boolean value; otherwise return `no`. + +.SH EXAMPLES +.EX +>> Bool.parse("yes") += yes : Bool? +>> Bool.parse("no") += no : Bool? +>> Bool.parse("???") += none : Bool? +.EE |