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

Extend documenation of formatFloat() (#5799)

Browse source 
Added line: "If ``precision == 0``, it tries to format it nicely." (copied from formatBiggestFloat())
This commit is contained in:
Simon Krauter 2017-05-13 21:50:44 +02:00 • committed by Andreas Rumpf
commit 40e9e751f0
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/pure/strutils.nim
View file

@ -1881,6 +1881,8 @@ proc formatFloat*(f: float, format: FloatFormatMode = ffDefault,
## of significant digits to be printed. ## of significant digits to be printed.
## `precision`'s default value is the maximum number of meaningful digits ## `precision`'s default value is the maximum number of meaningful digits
## 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.
result = formatBiggestFloat(f, format, precision, decimalSep) result = formatBiggestFloat(f, format, precision, decimalSep)
proc trimZeros*(x: var string) {.noSideEffect.} = proc trimZeros*(x: var string) {.noSideEffect.} =