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] Have description example match prop name #13570

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wbt
Copy link

@wbt wbt commented Jun 20, 2024

Including the s.

Including the s.

Signed-off-by: wbt <[email protected]>
@mui-bot
Copy link

mui-bot commented Jun 20, 2024

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

Generated by 🚫 dangerJS against 68345d7

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 your contribution @wbt! 🙏

The code for this comment lives here:

/**
* The time steps between two time unit options.
* For example, if `timeStep.minutes = 8`, then the available minute options will be `[0, 8, 16, 24, 32, 40, 48, 56]`.
* When single column time renderer is used, only `timeStep.minutes` will be used.
* @default{ hours: 1, minutes: 5, seconds: 5 }
*/
timeSteps?: TimeStepOptions;

Could you please fork the repo, create a branch, make the change there and run the necessary scripts (pnpm proptypes && pnpm docs:api) to update all dependant places (API page and JSDoc comment)?

While we are at it, could you please also update this very similar comment?

/**
* The time steps between two time unit options.
* For example, if `timeStep.minutes = 8`, then the available minute options will be `[0, 8, 16, 24, 32, 40, 48, 56]`.
* @default{ hours: 1, minutes: 5, seconds: 5 }
*/
timeSteps?: TimeStepOptions;

@LukasTy LukasTy added docs Improvements or additions to the documentation component: pickers This is the name of the generic UI component, not the React module! labels Jun 20, 2024
@LukasTy LukasTy changed the title Have description example match prop name [pickers] Have description example match prop name Jun 20, 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.

None yet

3 participants