aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.sqrt.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.sqrt.3
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Int.sqrt.3')
-rw-r--r--man/man3/tomo-Int.sqrt.336
1 files changed, 36 insertions, 0 deletions
diff --git a/man/man3/tomo-Int.sqrt.3 b/man/man3/tomo-Int.sqrt.3
new file mode 100644
index 00000000..8e6aba1d
--- /dev/null
+++ b/man/man3/tomo-Int.sqrt.3
@@ -0,0 +1,36 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Int.sqrt 3 2025-04-19T14:30:40.360844 "Tomo man-pages"
+.SH NAME
+Int.sqrt \- Calculates the nearest square root of an integer.
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Int.sqrt : func(x: Int -> Int)"
+.fi
+
+.SH DESCRIPTION
+Calculates the nearest square root of an integer.
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+x Int The integer whose square root is to be calculated. -
+.TE
+.SH RETURN
+The integer part of the square root of `x`.
+
+.SH EXAMPLES
+.EX
+>> (16).sqrt()
+= 4
+>> (17).sqrt()
+= 4
+.EE