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.

Sign up for GitHub

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

Jump to bottom

[docs] Fix 100+ typos throughout the Material UI docs #36194

Merged
merged 12 commits into from Apr 7, 2023
Merged

[docs] Fix 100+ typos throughout the Material UI docs #36194

merged 12 commits into from Apr 7, 2023

Conversation

Lioness100
Copy link
Contributor

This PR fixes some typos throughout the repository (this was a trial run for a CLI I made). I know this goes against the suggestion of creating multiple small PRs instead of one big one, since this obviously modifies a lot of code in many different files, so let me know if you want me to split this into multiple PRs. I'm for the most part unfamiliar with this codebase, so tell me if anything needs to be reverted! :) thanks.

Some notes:

  • I replaced "Temporaly" with "Temporarily" in ThemeModeToggle.tsx, but I'm not sure if that upholds the intent of the sentence, or if there was a typo to begin with.
  • I replaced "constast" with "contrast" in table.md, but am again not sure if that was correct
  • I replaced and renamed the file of "producBuoy.svg" to "productBuoy.svg". Not sure if that was correct.
  • Some of the fixes theoretically also fix bugs, such as the change of:
-       if (node.imported.name === 'ThemeProvider' || node.imported.nmae === 'MuiThemeProvider') {
+       if (node.imported.name === 'ThemeProvider' || node.imported.name === 'MuiThemeProvider') {

@mui-bot
Copy link

mui-bot commented Feb 15, 2023 •
edited

Netlify deploy preview

Bundle size report

Details of bundle changes

Generated by 🚫 dangerJS against 3d3dc71

@zannager zannager added the docs Improvements or additions to the documentation label Feb 15, 2023
siriwatknp
siriwatknp reviewed Feb 15, 2023
View reviewed changes
Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👏 Wow, this is nice!

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 16, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 30, 2023
samuelsycamore
samuelsycamore approved these changes Mar 30, 2023
View reviewed changes
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

This is awesome! Thank you @Lioness100 !! I can't find any problems or mistakes here.

I just resolved the merge conflicts. I suspect that they will keep popping up frequently, so we should merge this sooner rather than later.

Maybe someone else from @mui/core can confirm that nothing is broken?

@samuelsycamore samuelsycamore changed the title docs: fix typos [docs] Fix 100+ typos throughout the Material UI docs Mar 30, 2023
@samuelsycamore samuelsycamore requested a review from a team March 30, 2023 18:06
danilo-leal
danilo-leal approved these changes Mar 30, 2023
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Woo, this is awesome! We may want to do some triple-checking though just to make sure nothing has been broken because of this... but it seems alright!

michaldudak
michaldudak requested changes Mar 31, 2023
View reviewed changes
Copy link
Member

@michaldudak michaldudak 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 a great PR!
Merge conflict markers slipped through, though and need to be corrected before this is merged.

docs/data/joy/components/link/link.md Outdated Show resolved Hide resolved
docs/data/material/components/links/links.md Outdated Show resolved Hide resolved
packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts Outdated Show resolved Hide resolved
packages/mui-joy/src/Select/Select.test.tsx Show resolved Hide resolved
packages/mui-material/src/ListItem/ListItem.test.js Outdated Show resolved Hide resolved
packages/mui-material/src/ListItemText/ListItemText.spec.tsx Outdated Show resolved Hide resolved
samuelsycamore and others added 4 commits April 4, 2023 09:55
@samuelsycamore @michaldudak
Update docs/data/joy/components/link/link.md
67d14ee 
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@samuelsycamore @michaldudak
Update docs/data/material/components/links/links.md
17c6237 
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@samuelsycamore @michaldudak
Update packages/mui-material/src/ListItem/ListItem.test.js
39f7810 
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@samuelsycamore
nonexistent, merge noise
3d3dc71
danilo-leal
danilo-leal approved these changes Apr 6, 2023
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Haven't reviewed super in-depth all the 145 files 😬 but overall looks really good!

@samuelsycamore
Copy link
Member

I don't know why the test_e2e-1 is failing 😢

@ZeeshanTamboli
Copy link
Member

ZeeshanTamboli commented Apr 7, 2023 •
edited

I don't know why the test_e2e-1 is failing 😢

@samuelsycamore I reran the test_e2e-1. It was a timeout error. Now it has passed.

michaldudak
michaldudak approved these changes Apr 7, 2023
View reviewed changes
Copy link
Member

@michaldudak michaldudak left a comment

Choose a reason for hiding this comment

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

Looks great now, thanks!

@michaldudak michaldudak merged commit 6c6a39c into mui:master Apr 7, 2023
21 checks passed
@samuelsycamore
Copy link
Member

Thanks again @Lioness100! This was super helpful. Please feel free to open another PR like this for https://github.com/mui/mui-x and/or https://github.com/mui/mui-toolpad if you want to, and tag me for a review! 🙏

@Lioness100
Copy link
Contributor Author

Glad I could help! I'll see what I can do for the other repos :)

hbjORbj pushed a commit to hbjORbj/material-ui that referenced this pull request Apr 9, 2023
@Lioness100 @samuelsycamore
@michaldudak @hbjORbj
[docs] Fix 100+ typos throughout the Material UI docs (mui#36194)
f746b18 
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
@shaneomatz shaneomatz mentioned this pull request May 5, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samuelsycamore samuelsycamore samuelsycamore approved these changes

@michaldudak michaldudak michaldudak approved these changes

@siriwatknp siriwatknp siriwatknp approved these changes

@danilo-leal danilo-leal danilo-leal approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@Lioness100 @mui-bot @samuelsycamore @ZeeshanTamboli @michaldudak @siriwatknp @danilo-leal @zannager