feat: Improve text labels based on suggestions from chatGPT (#1118)

I asked chatGPT to help me brainstorm improvements to some of the labels and hint text based on the Apple Human Interface Guidelines. I then edited them as human to improve them further. Review and let me know if you think any are worse or weird. --------- Co-authored-by: Mike Bender <mikebender@deephaven.io>
deephaven · Mar 1, 2023 · d852e49 · d852e49
1 parent 4ed5787
commit d852e49
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 20 deletions.
diff --git a/packages/code-studio/src/settings/ColumnSpecificSectionContent.tsx b/packages/code-studio/src/settings/ColumnSpecificSectionContent.tsx
@@ -614,10 +614,9 @@ export class ColumnSpecificSectionContent extends PureComponent<
 
     return (
       <div className="app-settings-formatting-section" ref={this.containerRef}>
-        <div>Default formatting for matched column names</div>
         <div className="app-settings-menu-description mb-3">
-          Applies a formatting rule to all columns that match a specified name
-          and type.
+          Customize the formatting of table columns by applying rules based on
+          matching both a column name and column type.
         </div>
 
         <TransitionGroup

diff --git a/packages/code-studio/src/settings/FormattingSectionContent.tsx b/packages/code-studio/src/settings/FormattingSectionContent.tsx
@@ -429,9 +429,9 @@ export class FormattingSectionContent extends PureComponent<
     return (
       <div className="app-settings-formatting-section" ref={this.containerRef}>
         <div className="container-fluid p-0">
-          <div>Default formatting for column types</div>
           <div className="app-settings-menu-description mb-3">
-            Applies a formatting rule to all columns of a set type.
+            Choose the default formatting rule to apply to all table columns
+            based on their type.
           </div>
           <div className="form-row mb-2">
             <label

diff --git a/packages/code-studio/src/settings/SettingsMenu.tsx b/packages/code-studio/src/settings/SettingsMenu.tsx
@@ -143,7 +143,7 @@ export class SettingsMenu extends Component<
                   transform="grow-4"
                   className="mr-2"
                 />
-                Default Formatting &amp; Time zone
+                Default Format &amp; Time zone
               </>
             }
             onToggle={this.handleSectionToggle}
@@ -163,7 +163,7 @@ export class SettingsMenu extends Component<
                   transform="grow-4"
                   className="mr-2"
                 />
-                Column Specific Formatting Rules
+                Format by Column Name &amp; Type
               </>
             }
             onToggle={this.handleSectionToggle}

diff --git a/packages/code-studio/src/settings/ShortcutsSectionContent.tsx b/packages/code-studio/src/settings/ShortcutsSectionContent.tsx
@@ -62,8 +62,8 @@ function ShortcutSectionContent({
   return (
     <>
       <div className="app-settings-menu-description">
-        Customize shortcuts below. Assigning shortcuts that conflict with the
-        browser or IDE shortcuts may cause unintended behavior
+        Customize shortcuts below. To prevent unexpected results, avoid
+        conflicting shortcuts with the browser or IDE editor.
       </div>
       {categories.map(category => (
         <ShortcutCategory

diff --git a/packages/iris-grid/src/IrisGrid.tsx b/packages/iris-grid/src/IrisGrid.tsx
@@ -1075,7 +1075,7 @@ export class IrisGrid extends Component<IrisGridProps, IrisGridState> {
       }
       optionItems.push({
         type: OptionType.VISIBILITY_ORDERING_BUILDER,
-        title: 'Hide, Group, and Order Columns',
+        title: 'Organize Columns',
         icon: dhEye,
       });
       if (isFormatColumnsAvailable) {

diff --git a/packages/iris-grid/src/sidebar/AdvancedSettingsMenu.tsx b/packages/iris-grid/src/sidebar/AdvancedSettingsMenu.tsx
@@ -34,9 +34,9 @@ AdvancedSettingsMenu.getAdvancedSettingsTitleForKey = (
 ): string => {
   switch (key) {
     case AdvancedSettingsType.FILTER_CONTROL_CHANGE_CLEARS_ALL_FILTERS:
-      return 'Control filters clear existing table filters';
+      return 'Clear current table filters before applying new filters from a control';
     case AdvancedSettingsType.LINK_CHANGE_CLEARS_ALL_FILTERS:
-      return 'Inbound links clear existing table filters';
+      return 'Clear current table filters before applying new filters from an incoming link filter';
   }
 };
 

diff --git a/packages/iris-grid/src/sidebar/RollupRows.tsx b/packages/iris-grid/src/sidebar/RollupRows.tsx
@@ -517,8 +517,8 @@ class RollupRows extends Component<RollupRowsProps, RollupRowsState> {
                     // eslint-disable-next-line react/jsx-props-no-spreading
                     {...provided.droppableProps}
                   >
-                    Create rollup by dragging columns here, from the available
-                    columns list below.
+                    To create a rollup, drag columns from the list below and
+                    drop them into this area.
                   </div>
                 )}
               </Droppable>

diff --git a/packages/iris-grid/src/sidebar/SelectDistinctBuilder.tsx b/packages/iris-grid/src/sidebar/SelectDistinctBuilder.tsx
@@ -161,12 +161,9 @@ class SelectDistinctBuilder extends Component<
 
         <div className="select-distinct-builder-footer">
           <div className="select-distinct-builder-hint">
-            Modifies a table to show unique value from a column, same as{' '}
-            <span className="inline-code-snippet">
-              selectDistinct(&quot;Column&quot;)
-            </span>
-            . Filters will be reset and the resulting table will contain only
-            the selected columns above.
+            Display only unique values from the selected table columns. Note
+            that this will reset any filters and display only the selected
+            columns.
           </div>
         </div>
       </div>