aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.to.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-Int.to.3
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Int.to.3')
-rw-r--r--man/man3/tomo-Int.to.343
1 files changed, 43 insertions, 0 deletions
diff --git a/man/man3/tomo-Int.to.3 b/man/man3/tomo-Int.to.3
new file mode 100644
index 00000000..53b6b0ff
--- /dev/null
+++ b/man/man3/tomo-Int.to.3
@@ -0,0 +1,43 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Int.to 3 2025-04-19T14:30:40.360881 "Tomo man-pages"
+.SH NAME
+Int.to \- Returns an iterator function that iterates over the range of numbers specified.
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Int.to : func(first: Int, last: Int, step: Int? = none -> func(->Int?))"
+.fi
+
+.SH DESCRIPTION
+Returns an iterator function that iterates over the range of numbers specified.
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+first Int The starting value of the range. -
+last Int The ending value of the range. -
+step Int? An optional step size to use. If unspecified or `none`, the step will be inferred to be `+1` if `last >= first`, otherwise `-1`. none
+.TE
+.SH RETURN
+An iterator function that returns each integer in the given range (inclusive).
+
+.SH EXAMPLES
+.EX
+>> (2).to(5)
+= func(->Int?)
+>> [x for x in (2).to(5)]
+= [2, 3, 4, 5]
+>> [x for x in (5).to(2)]
+= [5, 4, 3, 2]
+
+>> [x for x in (2).to(5, step=2)]
+= [2, 4]
+.EE