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

[pickers] Improve onError JSDoc #14492

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Sep 5, 2024

Extracted from #14486

We have 3 places where the onError prop is defined, and IMHO the one used for the doc generation is not the best one.
I unified to 3 in this PR to avoid having massive doc generated file change in the main PR (where I move the 3 definition into a single place).

The current 3 formulation are the 3 last files on this PR if you want to compare them.

@flaviendelangle flaviendelangle added the component: pickers This is the name of the generic UI component, not the React module! label Sep 5, 2024
@flaviendelangle flaviendelangle self-assigned this Sep 5, 2024
@flaviendelangle flaviendelangle marked this pull request as ready for review September 5, 2024 07:11
@mui-bot
Copy link

mui-bot commented Sep 5, 2024

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

Generated by 🚫 dangerJS against 69c7142

@flaviendelangle flaviendelangle changed the title [pickers] Improve onError JSDoc [pickers] Improve onError JSDoc Sep 5, 2024
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Thank you for taking the time to align this. 🙏
Leaving suggestions for improvement (they are only in a single place, but would naturally be propagated to all places). 👌

@LukasTy LukasTy added the docs Improvements or additions to the documentation label Sep 5, 2024
@flaviendelangle flaviendelangle merged commit 4a8f44c into mui:master Sep 5, 2024
18 checks passed
@flaviendelangle flaviendelangle deleted the onError branch September 5, 2024 11:49
arthurbalduini pushed a commit to arthurbalduini/mui-x that referenced this pull request Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: pickers This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants