Correct description of float controls - min/max is for decimal places

* This wrongly said that it controlled the number of significant figures.
This commit is contained in:
baldurk
2019-02-07 15:23:07 +00:00
parent be67e91cc7
commit fc9249842a
2 changed files with 18 additions and 8 deletions
+12 -2
View File
@@ -564,13 +564,23 @@ For more information about some of these settings that are user-facing see
.. data:: Formatter_MinFigures
The minimum number of significant figures to show in formatted floating point values.
The minimum number of decimal places to show in formatted floating point values.
.. note::
The naming of 'MinFigures' is a historical artifact - this controls the number of decimal places
only, not the number of significant figures.
Defaults to ``2``.
.. data:: Formatter_MaxFigures
The maximum number of significant figures to show in formatted floating point values.
The maximum number of decimal places to show in formatted floating point values.
.. note::
The naming of 'MaxFigures' is a historical artifact - this controls the number of decimal places
only, not the number of significant figures.
Defaults to ``5``.