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-Byte.is_between.3 | |
| parent | 0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff) | |
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Byte.is_between.3')
| -rw-r--r-- | man/man3/tomo-Byte.is_between.3 | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/man/man3/tomo-Byte.is_between.3 b/man/man3/tomo-Byte.is_between.3 new file mode 100644 index 00000000..c963d054 --- /dev/null +++ b/man/man3/tomo-Byte.is_between.3 @@ -0,0 +1,40 @@ +'\" t +.\" Copyright (c) 2025 Bruce Hill +.\" All rights reserved. +.\" +.TH Byte.is_between 3 2025-04-19T14:30:40.360176 "Tomo man-pages" +.SH NAME +Byte.is_between \- Determines if an integer is between two numbers (inclusive). + +.SH LIBRARY +Tomo Standard Library +.SH SYNOPSIS +.nf +.BI "Byte.is_between : func(x: Byte, low: Byte, high: Byte -> Bool)" +.fi + +.SH DESCRIPTION +Determines if an integer is between two numbers (inclusive). + + +.TS +allbox; +lb lb lbx lb +l l l l. +Name Type Description Default +x Byte The integer to be checked. - +low Byte The lower bound to check (inclusive). - +high Byte The upper bound to check (inclusive). - +.TE +.SH RETURN +`yes` if `low <= x and x <= high`, otherwise `no` + +.SH EXAMPLES +.EX +>> Byte(7).is_between(1, 10) += yes +>> Byte(7).is_between(100, 200) += no +>> Byte(7).is_between(1, 7) += yes +.EE |