Skip to content

[docs] Fix typing errors in Rating component migration guide #45792

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

Closed
WinnieS0728 opened this issue Apr 2, 2025 · 6 comments
Closed

[docs] Fix typing errors in Rating component migration guide #45792

WinnieS0728 opened this issue Apr 2, 2025 · 6 comments
Labels
deprecation New deprecation message docs Improvements or additions to the documentation package: material-ui Specific to @mui/material

Comments

@WinnieS0728
Copy link

WinnieS0728 commented Apr 2, 2025

I created a pull request #45791 but I don't know how to create a label.
I got fail when ci verify.
so I create this Issue.

Issue Description

Found documentation typing errors related to Rating component migration guide.

1. Migration Guide Error

Location: Migrating from deprecated APIs

Current:

npx @mui/codemod@latest deprecations/step-label-props <path>

Should be:

npx @mui/codemod@latest deprecations/rating-props <path>

2. Codemod README Error

Location: codemod readme

Component name

Current

 <Snackbar
-  IconContainerComponent={CustomContainer}
+  slots={{
+    icon: { component: CustomContainer }
+  }}
 />

Should be:

 <Rating
-  IconContainerComponent={CustomContainer}
+  slots={{
+    icon: { component: CustomContainer }
+  }}
 />

command

Current

npx @mui/codemod deprecations/snackbar-props <path>

Should be

npx @mui/codemod deprecations/rating-props <path>

Your environment

npx @mui/envinfo
  System:
    OS: macOS 15.2
  Binaries:
    Node: 20.9.0 - ~/.nvm/versions/node/v20.9.0/bin/node
    npm: 10.1.0 - ~/.nvm/versions/node/v20.9.0/bin/npm
    pnpm: Not Found
  Browsers:
    Chrome: 134.0.6998.167
    Edge: Not Found
    Safari: 18.2
  npmPackages:
    @emotion/react: ^11.14.0 => 11.14.0 
    @emotion/styled: ^11.14.0 => 11.14.0 
    @mui/base:  5.0.0-beta.70 
    @mui/core-downloads-tracker:  6.4.9 
    @mui/icons-material: ^6.4.9 => 6.4.9 
    @mui/lab: 6.0.0-beta.32 => 6.0.0-beta.32 
    @mui/material: ^6.4.9 => 6.4.9 
    @mui/private-theming:  6.4.8 
    @mui/styled-engine:  6.4.9 
    @mui/system: ^6.4.9 => 6.4.9 
    @mui/types:  7.2.24 
    @mui/utils:  6.4.8 
    @mui/x-date-pickers: 6.20.2 => 6.20.2 
    @types/react: ^18.0.25 => 18.0.25 
    react: ^18.2.0 => 18.2.0 
    react-dom: ^18.2.0 => 18.2.0 
    styled-components: ^5.3.5 => 5.3.5 
    typescript: ^5.5.3 => 5.5.3 

Search keywords: doc v6 migration codemod rating-prop

@WinnieS0728 WinnieS0728 added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Apr 2, 2025
@Kartik-Murthy
Copy link
Contributor

Thank you for creating a pull request to address this issue! It's common for new contributors to face challenges with the CI process.

Regarding labels: Contributors typically don't need to add labels themselves - the repository maintainers will review your PR and add appropriate labels. So don't worry about that part.

For the CI verification failures, try running these commands locally to identify and fix the issues:

  • pnpm prettier - Formats your code to match the project style
  • pnpm eslint - Checks for linting issues
  • pnpm typescript - Verifies TypeScript types
  • pnpm proptypes && pnpm docs:api - Validates prop types and regenerates API docs
  • pnpm docs:typescript:formatted - Ensures TypeScript docs are properly formatted

Run these in the project root directory after installing dependencies. Each command should point you to specific issues that need fixing. Fix these locally, commit the changes, and push to your PR branch to trigger a new CI run.

If you'd like help with the specific CI errors, you could share the error details and I or someone else in the community might be able to help you resolve them.

Keep in mind that the Material UI team has specific contribution guidelines, so it might be worth checking their contributing documentation if you haven't already.

Don't be discouraged by initial setbacks - contributing to open source often involves a learning curve, and your efforts to fix this issue are appreciated!

@sai6855 sai6855 added docs Improvements or additions to the documentation deprecation New deprecation message package: material-ui Specific to @mui/material and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Apr 2, 2025
@sai6855
Copy link
Contributor

sai6855 commented Apr 2, 2025

@WinnieS0728 Label's will be added by maintainers, you need to worry about. If you wish to open PR again, please feel free to do it. Do note that there are unrelated changes in your closed PR, remove those and re-open PR

@WinnieS0728
Copy link
Author

@Kartik-Murthy @sai6855 thanks for helping me.
I'm new here and this is my first time create a pull request.
so I'm a little nervous.
thanks for those good ci command.

I'm not in office this week.
I will try again next week.

and I notice my unrelated changes.
It's my fault I'm not double check when I push commit.
but I don't know why they are change.
it's not change by me manually.
they show up when I save files.

I can record my screen in next comment next week when I'm in office.
maybe someone can explain why.

@WinnieS0728
Copy link
Author

@sai6855 I notice you have fixed the type issue. thank you very much.
and this is my screen record how the unrelated changes shows.

2025-04-07.9.32.10.mp4

I'm using cursor IDE,
but my only action is save the file.
no agent mode or press tab.

I don't know why this happened.

@sai6855
Copy link
Contributor

sai6855 commented Apr 8, 2025

@WinnieS0728 Okay, I'm not much familiar with cursor, so i'm not able to comment why it's causing the issue.

@sai6855 sai6855 closed this as completed Apr 8, 2025
Copy link

github-actions bot commented Apr 8, 2025

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation New deprecation message docs Improvements or additions to the documentation package: material-ui Specific to @mui/material
Projects
None yet
Development

No branches or pull requests

3 participants