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] Consistent type name in docs #26077

Merged
merged 9 commits into from
May 3, 2021
Merged

Conversation

jamesaucode
Copy link
Contributor

@jamesaucode jamesaucode commented May 1, 2021

As mentioned in #25970 , Boolean should be changed to bool to avoid confusion

Edit: Expanded this PR's scope per @oliviertassinari 's request and converted the following types as well:

Boolean -> bool
Function -> func
String -> string
Array -> array
Number -> number

Closes #25970

@jamesaucode jamesaucode closed this May 1, 2021
@mui-pr-bot
Copy link

mui-pr-bot commented May 1, 2021

No bundle size changes

Generated by 🚫 dangerJS against 765e7b3

@jamesaucode jamesaucode reopened this May 1, 2021
@jamesaucode jamesaucode changed the title Consistent type name in API from Boolean to bool [docs] Consistent type name in API from Boolean to bool May 1, 2021
@jamesaucode jamesaucode changed the title [docs] Consistent type name in API from Boolean to bool [docs] Consistent type name in docs from Boolean to bool May 1, 2021
@oliviertassinari
Copy link
Member

@jamesaucode Thanks for pushing this effort forward. What do you think about going all-in on this PR (migrating the other types and pages)?

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label May 1, 2021
@jamesaucode
Copy link
Contributor Author

@oliviertassinari yea for sure! I will do a more thorough search tomorrow and migrate all the other types and pages!

@jamesaucode jamesaucode changed the title [docs] Consistent type name in docs from Boolean to bool [docs] Consistent type name in docs May 1, 2021
@jamesaucode
Copy link
Contributor Author

@oliviertassinari Just did a more thorough rg and sed (then manually skimmed through them to make sure I didn't replace anything I shouldn't) to replace all the types you mentioned here, let me know if there are anything I missed.

@eps1lon eps1lon merged commit 9bfa7d6 into mui:next May 3, 2021
@eps1lon
Copy link
Member

eps1lon commented May 3, 2021

@jamesaucode Much appreciated, thanks!

eps1lon pushed a commit to eps1lon/material-ui that referenced this pull request May 3, 2021
@jamesaucode jamesaucode deleted the consistent-bool branch May 4, 2021 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Concistent type names in API
4 participants