From 40e9e751f0e77211442707820b4737a253334a4f Mon Sep 17 00:00:00 2001
From: Simon Krauter <trustable-code@users.noreply.github.com>
Date: Sat, 13 May 2017 21:50:44 +0200
Subject: Extend documenation of formatFloat() (#5799)

Added line: "If ``precision == 0``, it tries to format it nicely." (copied from formatBiggestFloat())
---
 lib/pure/strutils.nim | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'lib/pure/strutils.nim')

diff --git a/lib/pure/strutils.nim b/lib/pure/strutils.nim
index 9383675f4..458c22f3a 100644
--- a/lib/pure/strutils.nim
+++ b/lib/pure/strutils.nim
@@ -1881,6 +1881,8 @@ proc formatFloat*(f: float, format: FloatFormatMode = ffDefault,
   ## of significant digits to be printed.
   ## `precision`'s default value is the maximum number of meaningful digits
   ## after the decimal point for Nim's ``float`` type.
+  ##
+  ## If ``precision == 0``, it tries to format it nicely.
   result = formatBiggestFloat(f, format, precision, decimalSep)
 
 proc trimZeros*(x: var string) {.noSideEffect.} =
-- 
cgit 1.4.1-2-gfad0