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][material-ui][Autocomplete] Improve the options prop description #41591

Merged
merged 6 commits into from
Aug 9, 2024

Conversation

pluvio72
Copy link
Contributor

@pluvio72 pluvio72 commented Mar 21, 2024

@mui-bot
Copy link

mui-bot commented Mar 21, 2024

Netlify deploy preview

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

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against b81ad73

@zannager zannager added the component: autocomplete This is the name of the generic UI component, not the React module! label Mar 21, 2024
@danilo-leal danilo-leal changed the title [docs] Improve Autocomplete options prop description [docs][Autocomplete] Improve the options prop description Mar 21, 2024
@danilo-leal danilo-leal added the docs Improvements or additions to the documentation label Mar 21, 2024
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

@pluvio72 Thanks for the pull request. You need to first update the prop description in the type definition at

/**
* Array of options.
*/
options: ReadonlyArray<Value>;
and then run the following commands:

pnpm proptypes
pnpm docs:api

This will update the proptypes and API documentation accordingly.

CC @samuelsycamore for the description wording.

@ZeeshanTamboli ZeeshanTamboli added package: material-ui Specific to @mui/material enhancement This is not a bug, nor a new feature labels Mar 22, 2024
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

This affects the Base UI package, which isn't open for contributions in the Core repository. Contributions for Base UI should be made to the separate repository at https://github.com/mui/base-ui.

cc @mj12albert

@ZeeshanTamboli ZeeshanTamboli added package: base-ui Specific to @mui/base package: joy-ui Specific to @mui/joy labels Mar 22, 2024
@pluvio72
Copy link
Contributor Author

This affects the Base UI package, which isn't open for contributions in the Core repository. Contributions for Base UI should be made to the separate repository at https://github.com/mui/base-ui.

cc @mj12albert

Ahh I see, so I cannot commit changes to material-ui/packages/mui-base and have to commit the respective changes to the mui-base repository instead?

@ZeeshanTamboli
Copy link
Member

This affects the Base UI package, which isn't open for contributions in the Core repository. Contributions for Base UI should be made to the separate repository at https://github.com/mui/base-ui.
cc @mj12albert

Ahh I see, so I cannot commit changes to material-ui/packages/mui-base and have to commit the respective changes to the mui-base repository instead?

@pluvio72 I believe we need to wait for now. If we make changes to the base-ui repository, they won't be released until version 1 is ready there. Additionally, if we push changes in this repository, it will become out of sync with base-ui since there are duplicate copies of the same code. We intend to remove the Base UI code from this repository soon and make all changes exclusively in the base-ui repository. I'll keep this PR on hold until then.

@ZeeshanTamboli ZeeshanTamboli added the on hold There is a blocker, we need to wait label Mar 25, 2024
@ZeeshanTamboli ZeeshanTamboli removed on hold There is a blocker, we need to wait package: base-ui Specific to @mui/base package: joy-ui Specific to @mui/joy labels Aug 9, 2024
@ZeeshanTamboli ZeeshanTamboli changed the title [docs][Autocomplete] Improve the options prop description [docs][material-ui][Autocomplete] Improve the options prop description Aug 9, 2024
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

@pluvio72 Thanks for the pull request. We separated the code that depended on Base UI into its own chunk within Material UI, so this PR is now unblocked. I've pushed the changes, and it looks good to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Improve Autocomplete options prop description
5 participants