tomo-Num.percent.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Num.percent 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Num.percent \- format as a percentage
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Num.percent\ :\ func(n:\ Num,\ precision:\ Num\ =\ 0.01\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Convert a number into a percentage text with a percent sign.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 n	Num	The number to be converted to a percent. 	-
  26 precision	Num	Round the percentage to this precision level. 	0.01
  27 .TE
  28 .SH RETURN
  29 A text representation of the number as a percentage with a percent sign.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (0.5).percent() == "50%"
  34 assert (1./3.).percent(2) == "34%"
  35 assert (1./3.).percent(precision=0.0001) == "33.3333%"
  36 assert (1./3.).percent(precision=10.) == "30%"
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Num (3)