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] Sort Pickers & Charts API slots alphabetically #13843

Merged
merged 5 commits into from
Jul 15, 2024

Conversation

LukasTy
Copy link
Member

@LukasTy LukasTy commented Jul 15, 2024

Once again api:docs generation results have become flaky and sometimes keep failing in CI: https://app.circleci.com/pipelines/github/mui/mui-x/61920/workflows/b0db904d-129e-4379-9d5d-e7f23d837aea/jobs/353446.
Sorting them alphabetically would ensure this wouldn't happen. 🤔

Also added the same sorting for the Charts package based on: #13843 (comment)

@LukasTy LukasTy added docs Improvements or additions to the documentation core Infrastructure work going on behind the scenes labels Jul 15, 2024
@LukasTy LukasTy self-assigned this Jul 15, 2024
@LukasTy LukasTy requested review from a team and alexfauquette July 15, 2024 10:08
@mui-bot
Copy link

mui-bot commented Jul 15, 2024

Deploy preview: https://deploy-preview-13843--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 474d639

@JCQuintas
Copy link
Member

I think this would be useful for charts as well 👍

@LukasTy
Copy link
Member Author

LukasTy commented Jul 15, 2024

I think this would be useful for charts as well 👍

I just wanted to let you know, that flakiness has been observed only for Pickers previously and now again. 🤔
Would you like me to add the sort for it? 🤔
WDYT @alexfauquette?
What about @mui/xgrid? Do you like the existing order or do you feel having slots in alphabetical order would make more sense? 🤔

@JCQuintas
Copy link
Member

JCQuintas commented Jul 15, 2024

We see it on charts too, the flakiness

@LukasTy
Copy link
Member Author

LukasTy commented Jul 15, 2024

We see it on charts too, the flakiness

Oh, sorry, I didn't notice it then. 🙈

@JCQuintas
Copy link
Member

@LukasTy it usually happens in the pull request themselves when we change import orders. Sometimes it creates a chain effect that changes a lot of files :(

@LukasTy
Copy link
Member Author

LukasTy commented Jul 15, 2024

it usually happens in the pull request themselves when we change import orders. Sometimes it creates a chain effect that changes a lot of files :(

Gotcha. I've added Charts to the sorted list. 😉
Let's wait for @alexfauquette and Grid input. 🤞

@LukasTy LukasTy changed the title [docs] Sort Pickers API slots alphabetically [docs] Sort Pickers & Charts API slots alphabetically Jul 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.

It's ok for charts 👍

Thanks for taking care of it :)

@LukasTy LukasTy merged commit fa3649e into mui:master Jul 15, 2024
17 checks passed
@LukasTy LukasTy deleted the ensure-API-slots-order branch July 15, 2024 14:07
DungTiger pushed a commit to DungTiger/mui-x that referenced this pull request Jul 23, 2024
thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants