changeset 1786:d9e78b81ecdf

Make ProgressHandle messages consistent PR2618 http://icedtea.classpath.org/pipermail/thermostat/2015-September/016067.html Reviewed-by: omajid, jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2015-August/015625.html
author Andrew Azores <aazores@redhat.com>
date Fri, 28 Aug 2015 16:00:34 -0400
parents 4575ba459d09
children f3c017005021
files HACKING thread/client-controllers/src/main/resources/com/redhat/thermostat/thread/client/controller/impl/strings.properties vm-heap-analysis/client-core/src/main/resources/com/redhat/thermostat/vm/heap/analysis/client/locale/strings.properties vm-profiler/client-swing/src/main/resources/com/redhat/thermostat/vm/profiler/client/swing/internal/strings.properties
diffstat 4 files changed, 30 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/HACKING	Fri Sep 11 10:52:58 2015 -0400
+++ b/HACKING	Fri Aug 28 16:00:34 2015 -0400
@@ -83,6 +83,31 @@
     }
 
 
+UI Message Style
+----------------
+
+Messages displayed in progress handles should be short but mostly-complete
+sentence fragments. Overly verbose messages clutter the UI, but overly curt
+messages maybe not provide the user with enough information to distinguish
+which task a progress notification belongs to.
+
+Additionally, messages should be properly capitalized, and should be
+terminated with the Unicode horizontal ellipsis character ('\u2026')
+immediately following the final character of the message itself - in other
+words, there should be no space between the message and the ellipsis.
+
+This is a good example of a progress handle message:
+
+"Starting profiling\u2026"
+
+The following are bad examples of the same message:
+
+"Starting\u2026" (what task is starting?)
+"Profiling\u2026" (what is profiling doing?)
+"Starting profiling..." (these are three periods, not an ellipsis character)
+"Starting profiling \u2026" (space before the ellipsis)
+"starting profiling\u2026" (not capitalized correctly)
+
 
 Tests
 -----
--- a/thread/client-controllers/src/main/resources/com/redhat/thermostat/thread/client/controller/impl/strings.properties	Fri Sep 11 10:52:58 2015 -0400
+++ b/thread/client-controllers/src/main/resources/com/redhat/thermostat/thread/client/controller/impl/strings.properties	Fri Aug 28 16:00:34 2015 -0400
@@ -1,5 +1,5 @@
 CONTROLLER_NAME = Threads
 WARNING_CANNOT_ENABLE = Cannot enable Thread recording
 WARNING_CANNOT_DISABLE = Cannot disable Thread recording
-CHECKING_FOR_DEADLOCKS = Checking for deadlocks...
+CHECKING_FOR_DEADLOCKS = Checking for deadlocks\u2026
 NO_DEADLOCK_DETECTED = No Deadlocks Detected.
\ No newline at end of file
--- a/vm-heap-analysis/client-core/src/main/resources/com/redhat/thermostat/vm/heap/analysis/client/locale/strings.properties	Fri Sep 11 10:52:58 2015 -0400
+++ b/vm-heap-analysis/client-core/src/main/resources/com/redhat/thermostat/vm/heap/analysis/client/locale/strings.properties	Fri Aug 28 16:00:34 2015 -0400
@@ -34,8 +34,8 @@
 TRIGGER_HEAP_DUMP = Heap Dump
 LIST_DUMPS_ACTION = List Dumps
 DUMPS_LIST = Available Dumps
-HEAP_DUMP_IN_PROGRESS = dumping...
-HEAP_DUMP_LOADING_IN_PROGRESS = loading...
+HEAP_DUMP_IN_PROGRESS = Dumping heap\u2026
+HEAP_DUMP_LOADING_IN_PROGRESS = Loading heap dump\u2026
 PROCESS_EXITED = Process exited.
 
 ZOOM_IN = Zoom in the selected item. Try also with a double click
--- a/vm-profiler/client-swing/src/main/resources/com/redhat/thermostat/vm/profiler/client/swing/internal/strings.properties	Fri Sep 11 10:52:58 2015 -0400
+++ b/vm-profiler/client-swing/src/main/resources/com/redhat/thermostat/vm/profiler/client/swing/internal/strings.properties	Fri Aug 28 16:00:34 2015 -0400
@@ -8,9 +8,9 @@
 PROFILER_CURRENT_STATUS_ACTIVE = Currently profiling: yes
 PROFILER_CURRENT_STATUS_INACTIVE = Currently profiling: no
 START_PROFILING = Start Profiling
-STARTING_PROFILING = Starting profiling...
+STARTING_PROFILING = Starting profiling\u2026
 STOP_PROFILING = Stop Profiling
-STOPPING_PROFILING = Stopping profiling...
+STOPPING_PROFILING = Stopping profiling\u2026
 
 PROFILER_LIST_ITEM = Session @ {1} ({0})
 PROFILER_RESULTS_METHOD = Method