Skip to content
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-infra] Fix display when the default props is undefined #41114

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Feb 15, 2024

This bug has been visible for a while, e.g. in #39689 (review). It feels like there is a bug in the way the data is displayed, it doesn't feel like I can 100% trust what's shown on the API page. I saw this in mui/mui-x#11996.

Before https://deploy-preview-41113--material-ui.netlify.app/material-ui/api/app-bar/#props
SCR-20240215-oxfi

After https://deploy-preview-41114--material-ui.netlify.app/material-ui/api/app-bar/#props
SCR-20240215-szps

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work regression A bug, but worse scope: docs-infra Specific to the docs-infra product labels Feb 15, 2024
@mui-bot
Copy link

mui-bot commented Feb 15, 2024

Netlify deploy preview

https://deploy-preview-41114--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against f892e93

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will say, though, that I'm not particularly bothered by the "regression". I think a blank space bothers me more than an empty code block that looks like a dash, which fills up the space somehow instead of leaving it there empty. It could be just personal preference.

@oliviertassinari oliviertassinari removed the regression A bug, but worse label Feb 15, 2024
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Feb 15, 2024

@oliviertassinari oliviertassinari added enhancement This is not a bug, nor a new feature and removed bug 🐛 Something doesn't work labels Feb 15, 2024
@danilo-leal
Copy link
Contributor

Deal 😃 👍

@oliviertassinari oliviertassinari removed the request for review from alexfauquette February 15, 2024 20:57
@oliviertassinari oliviertassinari force-pushed the docs-infra-fix-prop-defaults branch from de9b76d to f892e93 Compare February 15, 2024 20:59
@oliviertassinari oliviertassinari changed the title [docs-infra] Fix display of empty default props [docs-infra] Fix display when the default props is undefined Feb 15, 2024
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deal 😃 👍

I introduced the regression with the new design but at that time I got the same feeling as danilo: "looks more like a feature than a bug" 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants