From a0739f40afa264a512e15fa63013410f7ed06a05 Mon Sep 17 00:00:00 2001 From: JT Smith Date: Sat, 15 Feb 2003 20:20:55 +0000 Subject: [PATCH] updated round docs --- lib/WebGUI/Utility.pm | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/lib/WebGUI/Utility.pm b/lib/WebGUI/Utility.pm index 04f2f14ab..9b8f3f2ea 100644 --- a/lib/WebGUI/Utility.pm +++ b/lib/WebGUI/Utility.pm @@ -274,16 +274,22 @@ sub randomizeHash { #------------------------------------------------------------------- -=head2 round ( real ) +=head2 round ( float [, significantDigits ] ) -Returns an integer after rounding a real number. +Returns an integer after rounding a floating point number. =over -=item real +=item float Any floating point number. +=item significantDigits + +The number of digits to leave after the decimal point. Defaults to 0. + +NOTE: If you set this higher than 0 then you'll get back another floating point number rather than an integer. + =back =cut