From fc9249842ac5ba0c2d7e41d97c7e45becacee7b9 Mon Sep 17 00:00:00 2001
From: baldurk <baldurk@baldurk.org>
Date: Thu, 7 Feb 2019 14:14:19 +0000
Subject: [PATCH] Correct description of float controls - min/max is for
 decimal places

* This wrongly said that it controlled the number of significant figures.
---
 qrenderdoc/Code/Interface/PersistantConfig.h | 14 ++++++++++++--
 qrenderdoc/Windows/Dialogs/SettingsDialog.ui | 12 ++++++------
 2 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/qrenderdoc/Code/Interface/PersistantConfig.h b/qrenderdoc/Code/Interface/PersistantConfig.h
index fab0421af..97a3a7a40 100644
--- a/qrenderdoc/Code/Interface/PersistantConfig.h
+++ b/qrenderdoc/Code/Interface/PersistantConfig.h
@@ -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``.
 
diff --git a/qrenderdoc/Windows/Dialogs/SettingsDialog.ui b/qrenderdoc/Windows/Dialogs/SettingsDialog.ui
index c3e5e7037..228d9909a 100644
--- a/qrenderdoc/Windows/Dialogs/SettingsDialog.ui
+++ b/qrenderdoc/Windows/Dialogs/SettingsDialog.ui
@@ -208,8 +208,8 @@ Since this is a global system hook it must be used carefully and only when neces
           <item row="3" column="1">
            <widget class="QSpinBox" name="Formatter_MaxFigures">
             <property name="toolTip">
-             <string>No more significant figures than this will be displayed on floats.
-e.g. a value of 5 means 0.123456789 will display as 0.12345</string>
+             <string>No more decimal places than this will be displayed on floats.
+e.g. a value of 5 means 0.123456789 will display as 0.12345 and 123.123456789 will display as 123.12345</string>
             </property>
             <property name="value">
              <number>5</number>
@@ -350,8 +350,8 @@ E.g. a value of 3 means 0.005 / 10 = 5E-4</string>
           <item row="2" column="0">
            <widget class="QLabel" name="label">
             <property name="toolTip">
-             <string>Decimals will display at least this many digits.
-e.g. a value of 2 means 0 will display as 0.00, 0.5 as 0.50</string>
+             <string>At least this many decimal places will be displayed on floats.
+e.g. a value of 2 means 0 will display as 0.00, 0.5 as 0.50. A value of 5 would display them as 0.00000 and 0.50000 respectively.</string>
             </property>
             <property name="text">
              <string>Minimum decimal places on float values</string>
@@ -376,11 +376,11 @@ Since this is a global system hook it must be used carefully and only when neces
           <item row="3" column="0">
            <widget class="QLabel" name="label_2">
             <property name="toolTip">
-             <string>No more significant figures than this will be displayed on floats.
+             <string>No more decimal places than this will be displayed on floats.
 e.g. a value of 5 means 0.123456789 will display as 0.12345</string>
             </property>
             <property name="text">
-             <string>Maximum significant figures on decimals</string>
+             <string>Maximum decimal places on float values</string>
             </property>
            </widget>
           </item>