jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added doc examples for formatFloat (#6704)

Browse source
This commit is contained in:
Fabian Keller 2017-11-07 08:07:25 +01:00 • committed by Andreas Rumpf
commit 7c588f2cc4
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/pure/strutils.nim
View file

@ -2007,6 +2007,16 @@ proc formatFloat*(f: float, format: FloatFormatMode = ffDefault,
## after the decimal point for Nim's ``float`` type. ## after the decimal point for Nim's ``float`` type.
## ##
## If ``precision == 0``, it tries to format it nicely. ## If ``precision == 0``, it tries to format it nicely.
##
## Examples:
##
## .. code-block:: nim
##
## let x = 123.456
## echo x.formatFloat() # 123.4560000000000
## echo x.formatFloat(ffDecimal, 4) # 123.4560
## echo x.formatFloat(ffScientific, 2) # 1.23e+02
##
result = formatBiggestFloat(f, format, precision, decimalSep) result = formatBiggestFloat(f, format, precision, decimalSep)
proc trimZeros*(x: var string) {.noSideEffect.} = proc trimZeros*(x: var string) {.noSideEffect.} =