New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Remove ` around @default values #12158
Conversation
Deploy preview: https://deploy-preview-12158--material-ui-x.netlify.app/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we could even throw during the build step if a default
starts and ends with the ` char?
The issue is that it can make sense, for example |
"start with The idea is just that if we can catch most bad usages of `, even if it's not 100%, it will make is easier to keep consistency |
@flaviendelangle I gave it a try by logging warning in the |
We have the two way of defining default that exist:
The docs currently support the second one. Otherwise you get the following rendering in API pages
https://mui.com/x/api/date-pickers/multi-input-date-range-field/#multi-input-date-range-field-prop-shouldRespectLeadingZeros
Better to wait for #41069 to avoid issues with the MD file generation used by data grid interfacesTo post in slack when merging