diff options
Diffstat (limited to 'man/man3/tomo-Bool.parse.3')
| -rw-r--r-- | man/man3/tomo-Bool.parse.3 | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/man/man3/tomo-Bool.parse.3 b/man/man3/tomo-Bool.parse.3 index 81830fb3..e1d5f3b7 100644 --- a/man/man3/tomo-Bool.parse.3 +++ b/man/man3/tomo-Bool.parse.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Bool.parse 3 2025-04-30 "Tomo man-pages" +.TH Bool.parse 3 2025-08-16 "Tomo man-pages" .SH NAME Bool.parse \- parse into boolean .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI Bool.parse\ :\ func(text:\ Text\ ->\ Bool?) +.BI Bool.parse\ :\ func(text:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Bool?) .fi .SH DESCRIPTION Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`. @@ -23,6 +23,7 @@ lb lb lbx lb l l l l. Name Type Description Default text Text The string containing the boolean value. - +remainder &Text? If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches. none .TE .SH RETURN `yes` if the string matches a recognized truthy boolean value; otherwise return `no`. @@ -35,4 +36,12 @@ text Text The string containing the boolean value. - = no : Bool? >> Bool.parse("???") = none : Bool? + +>> Bool.parse("yesJUNK") += none : Bool? +remainder : Text +>> Bool.parse("yesJUNK", &remainder) += yes : Bool? +>> remainder += "JUNK" .EE |