aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Num.is_between.3
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
commit67fd3c725e6511adf70345f0733ec0b948477a11 (patch)
tree913d9f30d8ce3614a9ae3715281f8804323b24ff /man/man3/tomo-Num.is_between.3
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Num.is_between.3')
-rw-r--r--man/man3/tomo-Num.is_between.340
1 files changed, 40 insertions, 0 deletions
diff --git a/man/man3/tomo-Num.is_between.3 b/man/man3/tomo-Num.is_between.3
new file mode 100644
index 00000000..5b008cbb
--- /dev/null
+++ b/man/man3/tomo-Num.is_between.3
@@ -0,0 +1,40 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Num.is_between 3 2025-04-19T14:30:40.362934 "Tomo man-pages"
+.SH NAME
+Num.is_between \- Determines if a number is between two numbers (inclusive).
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Num.is_between : func(x: Num, low: Num, high: Num -> Bool)"
+.fi
+
+.SH DESCRIPTION
+Determines if a number is between two numbers (inclusive).
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+x Num The integer to be checked. -
+low Num The lower bound to check (inclusive). -
+high Num The upper bound to check (inclusive). -
+.TE
+.SH RETURN
+`yes` if `low <= x and x <= high`, otherwise `no`
+
+.SH EXAMPLES
+.EX
+>> (7.5).is_between(1, 10)
+= yes
+>> (7.5).is_between(100, 200)
+= no
+>> (7.5).is_between(1, 7.5)
+= yes
+.EE