Skip to content

Commit

Permalink
Remove unneccessary syntax in JS Comment Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lev Shapiro authored and Lev Shapiro committed Oct 3, 2023
1 parent e9f90e2 commit ce4fe6d
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ 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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1008,7 +1008,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({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,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({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface GridGroupingColDefOverride<R extends GridValidRowModel = any>
* 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;

Expand All @@ -27,7 +27,7 @@ export interface GridGroupingColDefOverride<R extends GridValidRowModel = any>

/**
* If `true`, the grouping cells will not render the amount of descendants.
* @default: false
* @default false
*/
hideDescendantCount?: boolean;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,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
*/
unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([
PropTypes.shape({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
unstable_ignoreValueFormatterDuringExport:
| boolean
Expand Down

0 comments on commit ce4fe6d

Please sign in to comment.