From 87815c04e1bfd8cefe30fd25585fd483044bb6b8 Mon Sep 17 00:00:00 2001 From: Lev-Shapiro <96536068+Lev-Shapiro@users.noreply.github.com> Date: Wed, 11 Oct 2023 17:11:22 +0300 Subject: [PATCH] [DataGrid] Remove unnecessary syntax in JSDoc (#10567) Co-authored-by: Lev Shapiro Co-authored-by: Olivier Tassinari --- docs/pages/x/api/data-grid/data-grid-premium.json | 2 +- docs/pages/x/api/data-grid/data-grid-pro.json | 2 +- docs/pages/x/api/data-grid/data-grid.json | 2 +- .../src/services/tree-data-generator.ts | 5 ++--- .../src/DataGridPremium/DataGridPremium.tsx | 2 +- .../grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx | 2 +- .../x-data-grid-pro/src/models/gridGroupingColDefOverride.ts | 4 ++-- packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx | 2 +- packages/grid/x-data-grid/src/models/props/DataGridProps.ts | 2 +- 9 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/pages/x/api/data-grid/data-grid-premium.json b/docs/pages/x/api/data-grid/data-grid-premium.json index 3c104fbeb986..8e84fafb5d40 100644 --- a/docs/pages/x/api/data-grid/data-grid-premium.json +++ b/docs/pages/x/api/data-grid/data-grid-premium.json @@ -608,7 +608,7 @@ "name": "union", "description": "{ clipboardExport?: bool, csvExport?: bool }
| bool" }, - "default": ": false" + "default": "false" }, "unstable_onCellSelectionModelChange": { "type": { "name": "func" }, diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json index cf6c9e9310c3..0a7cbf32e460 100644 --- a/docs/pages/x/api/data-grid/data-grid-pro.json +++ b/docs/pages/x/api/data-grid/data-grid-pro.json @@ -557,7 +557,7 @@ "name": "union", "description": "{ clipboardExport?: bool, csvExport?: bool }
| bool" }, - "default": ": false" + "default": "false" } }, "slots": [ diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json index 15d987cefe64..3cd3f1cbd975 100644 --- a/docs/pages/x/api/data-grid/data-grid.json +++ b/docs/pages/x/api/data-grid/data-grid.json @@ -429,7 +429,7 @@ "name": "union", "description": "{ clipboardExport?: bool, csvExport?: bool }
| bool" }, - "default": ": false" + "default": "false" } }, "slots": [ diff --git a/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts b/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts index 80e37aeb901a..57ae9f0dfc27 100644 --- a/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts +++ b/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts @@ -11,13 +11,12 @@ export interface AddPathToDemoDataOptions { /** * The depth of the tree - * @default: 1 + * @default 1 */ maxDepth?: number; - /** * The average amount of children in a node - * @default: 2 + * @default 2 */ averageChildren?: number; } diff --git a/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx b/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx index d4ed6e679b05..12d57e5b7cb5 100644 --- a/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx +++ b/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx @@ -1015,7 +1015,7 @@ DataGridPremiumRaw.propTypes = { /** * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard. * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export. - * @default: false + * @default false */ unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([ PropTypes.shape({ diff --git a/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx b/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx index 07479dba9a3e..3a0e768e2e03 100644 --- a/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx +++ b/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx @@ -931,7 +931,7 @@ DataGridProRaw.propTypes = { /** * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard. * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export. - * @default: false + * @default false */ unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([ PropTypes.shape({ diff --git a/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts b/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts index d85d87d91bb0..ab6f80261c46 100644 --- a/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts +++ b/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts @@ -15,7 +15,7 @@ export interface GridGroupingColDefOverride * The field from which we want to apply the sorting and the filtering for the grouping column. * It is only useful when `props.rowGroupingColumnMode === "multiple"` to decide which grouping criteria should be used for sorting and filtering. * Do not have any effect when building the tree with the `props.treeData` feature. - * @default: The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria. + * @default The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria. */ mainGroupingCriteria?: string; @@ -27,7 +27,7 @@ export interface GridGroupingColDefOverride /** * If `true`, the grouping cells will not render the amount of descendants. - * @default: false + * @default false */ hideDescendantCount?: boolean; } diff --git a/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx b/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx index 9c447dc7da0a..dabc61e808c8 100644 --- a/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx +++ b/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx @@ -712,7 +712,7 @@ DataGridRaw.propTypes = { /** * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard. * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export. - * @default: false + * @default false */ unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([ PropTypes.shape({ diff --git a/packages/grid/x-data-grid/src/models/props/DataGridProps.ts b/packages/grid/x-data-grid/src/models/props/DataGridProps.ts index 647e04f9dae3..46b868c7c67b 100644 --- a/packages/grid/x-data-grid/src/models/props/DataGridProps.ts +++ b/packages/grid/x-data-grid/src/models/props/DataGridProps.ts @@ -358,7 +358,7 @@ export interface DataGridPropsWithDefaultValues { /** * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard. * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export. - * @default: false + * @default false */ unstable_ignoreValueFormatterDuringExport: | boolean