[DataGrid] Remove unnecessary syntax in JSDoc #10567
Conversation
|
Deploy preview: https://deploy-preview-10567--material-ui-x.netlify.app/ |
|
Hello @Lev-Shapiro |
|
An accident, but could you help me understand what it means when |
Gotcha. 👌 |
LukasTy
added
core
LukasTy
changed the title
| @@ -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. | |||
There was a problem hiding this comment.
this is not the intended usage of the @default directive. @cherniavskii do we use it that way in the codebase very often?
There was a problem hiding this comment.
I guess I could also answer this question. I've found yesterday many incorrect usages of the @default directive some have syntax problems and some incorrect usages of that directive, I could try make a more global PR and an issue to fix it, sounds good?
There was a problem hiding this comment.
It's used in a similar way in the Pickers codebase a few times as well. 🤔
Maybe it's not the most correct usage, but it works and helps us to build the API documentation that would be useful. 🙈
There was a problem hiding this comment.
@Lev-Shapiro thanks, but that's not what I intended with that comment. I know it is not the correct usage of it, but my intention was to know if we use it that way elsewhere or if it is the only time.
As mentioned by @LukasTy it does not pose any threat and if it is a valuable tool we should continue using it like this! 💯
| @@ -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 | |||
There was a problem hiding this comment.
This is technically touching non-MIT code.
Do we need to go with the SLA process for even non-functional changes?
cc @joserodolfofreitas @DanailH
There was a problem hiding this comment.
@LukasTy I believe we need a CLA for any change in the commercially licensed folder.
There was a problem hiding this comment.
Although in our CLA docs it says:
If the change is nontrivial and user-facing, the CLA needs to be signed.
There was a problem hiding this comment.
I have updated https://www.notion.so/mui-org/CLA-Contributor-License-Agreement-92ece655b1584b10b00e4de9e67eedb0?pvs=4#ede845886e494cb4b802a67563152130 to detail my take on this topic, inspired by OpenSSL.
Here, I think we can consider it's a trivial change, if the author agrees too, we could move forward without signing a CLA.
There was a problem hiding this comment.
Yeah, sure, let's move forward
oliviertassinari
added
docs
packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Olivier Tassinari <[email protected]> Signed-off-by: Lev-Shapiro <[email protected]>
This PR fixes #10568