aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Num.format.3
blob: eedd87a4f75c567e19ebea786421dc645860e7f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Num.format 3 2025-04-19T14:30:40.362831 "Tomo man-pages"
.SH NAME
Num.format \- Formats a number as a text with a specified precision.

.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI "Num.format : func(n: Num, precision: Int = 0 -> Text)"
.fi

.SH DESCRIPTION
Formats a number as a text with a specified precision.


.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
n	Num	The number to be formatted. 	-
precision	Int	The number of decimal places. Default is `0`. 	0
.TE
.SH RETURN
A text representation of the number with the specified precision.

.SH EXAMPLES
.EX
>> (3.14159).format(precision=2)
= "3.14"
.EE