fix: update chart sorting control labels/descriptions (apache#1462)

Co-authored-by: John Bodley <john.bodley@airbnb.com>
zhaoyongjie · Nov 25, 2021 · a9fd15b · a9fd15b
1 parent e84f3b5
commit a9fd15b
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 20 deletions.
diff --git a/...et_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx b/...et_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/dndControls.tsx
@@ -31,8 +31,8 @@ export const dndGroupByControl: SharedControlConfig<'DndColumnSelect'> = {
   label: t('Group by'),
   default: [],
   description: t(
-    'One or many columns to group by. High cardinality groupings should include a sort by metric ' +
-      'and series limit to limit the number of fetched and rendered series.',
+    'One or many columns to group by. High cardinality groupings should include a series limit ' +
+      'to limit the number of fetched and rendered series.',
   ),
   mapStateToProps(state, { includeTime }) {
     const newState: ExtraControlProps = {};
@@ -125,8 +125,8 @@ export const dnd_sort_by: SharedControlConfig<'DndMetricSelect'> = {
   label: t('Sort by'),
   default: null,
   description: t(
-    'Metric used to define the top series. Should be used in conjunction with the series or row ' +
-      'limit.',
+    'Metric used to define how the top series are sorted if a series or row limit is present. ' +
+      'If undefined reverts to the first metric (where appropriate).',
   ),
   mapStateToProps: ({ datasource }) => ({
     columns: datasource?.columns || [],

diff --git a/...superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx b/...superset_ui/superset-ui/packages/superset-ui-chart-controls/src/shared-controls/index.tsx
@@ -332,10 +332,7 @@ const row_limit: SharedControlConfig<'SelectControl'> = {
   validators: [legacyValidateInteger],
   default: 10000,
   choices: formatSelectOptions(ROW_LIMIT_OPTIONS),
-  description: t(
-    'Limits the number of rows that get displayed. Should be used in conjunction with a sort ' +
-      'by metric.',
-  ),
+  description: t('Limits the number of rows that get displayed.'),
 };
 
 const limit: SharedControlConfig<'SelectControl'> = {
@@ -346,11 +343,10 @@ const limit: SharedControlConfig<'SelectControl'> = {
   choices: formatSelectOptions(SERIES_LIMITS),
   clearable: true,
   description: t(
-    'Limits the number of series that get displayed. Should be used in conjunction with a sort ' +
-      'by metric. A joined subquery (or an extra phase where subqueries are not supported) is ' +
-      'applied to limit the number of series that get fetched and rendered. This feature is ' +
-      'useful when grouping by high cardinality column(s) though does increase the query ' +
-      'complexity and cost.',
+    'Limits the number of series that get displayed. A joined subquery (or an extra phase ' +
+      'where subqueries are not supported) is applied to limit the number of series that get ' +
+      'fetched and rendered. This feature is useful when grouping by high cardinality ' +
+      'column(s) though does increase the query complexity and cost.',
   ),
 };
 
@@ -361,11 +357,10 @@ const series_limit: SharedControlConfig<'SelectControl'> = {
   validators: [legacyValidateInteger],
   choices: formatSelectOptions(SERIES_LIMITS),
   description: t(
-    'Limits the number of series that get displayed. Should be used in conjunction with a sort ' +
-      'by metric. A joined subquery (or an extra phase where subqueries are not supported) is ' +
-      'applied to limit the number of series that get fetched and rendered. This feature is ' +
-      'useful when grouping by high cardinality column(s) though does increase the query ' +
-      'complexity and cost.',
+    'Limits the number of series that get displayed. A joined subquery (or an extra phase ' +
+      'where subqueries are not supported) is applied to limit the number of series that get ' +
+      'fetched and rendered. This feature is useful when grouping by high cardinality ' +
+      'column(s) though does increase the query complexity and cost.',
   ),
 };
 
@@ -374,8 +369,8 @@ const sort_by: SharedControlConfig<'MetricsControl'> = {
   label: t('Sort by'),
   default: null,
   description: t(
-    'Metric used to define the top series. Should be used in conjunction with the series or row ' +
-      'limit',
+    'Metric used to define how the top series are sorted if a series or row limit is present. ' +
+      'If undefined reverts to the first metric (where appropriate).',
   ),
   mapStateToProps: ({ datasource }) => ({
     columns: datasource?.columns || [],