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] Clarify difference in startup times between named and default imports in minimizing-bundle-size.md #33109

Merged
merged 8 commits into from Aug 10, 2022

Conversation

cmdcolin
Copy link
Contributor

Hi there! I was trying to work out a bug where I am seeing a bunch of icons in my built version. I am not sure why but while trying to debug I came across this part of the documentation. I added some changes in this PR to try to clarify this section in detail cause it's a little hard to interpret. Let me know if that helps!

@mui-bot
Copy link

mui-bot commented Jun 12, 2022

No bundle size changes

Generated by 🚫 dangerJS against 97d9f8d

…ndle-size.md

Co-authored-by: Marija Najdova <mnajdova@gmail.com>
@michaldudak
Copy link
Member

Please run yarn prettier, then yarn markdownlint and fix the violations if they still exist.

@cmdcolin
Copy link
Contributor Author

cmdcolin commented Jul 1, 2022

Added lint, thanks for the reminder @michaldudak

Also, can take or leave this wording suggestion, it is certainly more verbose but I thought just spelling it out could help.

Comment on lines 29 to 31
Startup times can be approximately 6x slower with named imports than without e.g.

In some cases
Copy link
Member

Choose a reason for hiding this comment

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

I'd remove the "in some cases". We already say that they can be slower.

Suggested change
Startup times can be approximately 6x slower with named imports than without e.g.
In some cases
Startup times can be approximately 6x slower with named imports than without e.g.:

@michaldudak
Copy link
Member

@samuelsycamore would you mind taking a quick look?

cmdcolin and others added 4 commits July 11, 2022 15:06
…ndle-size.md

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@samuelsycamore samuelsycamore changed the title Update minimizing-bundle-size.md [docs] Clarify difference in speed between named and default imports in minimizing-bundle-size.md Aug 10, 2022
@samuelsycamore samuelsycamore changed the title [docs] Clarify difference in speed between named and default imports in minimizing-bundle-size.md [docs] Clarify difference in startup times between named and default imports in minimizing-bundle-size.md Aug 10, 2022
@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Aug 10, 2022
@samuelsycamore samuelsycamore merged commit 472e284 into mui:master Aug 10, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
…imports in minimizing-bundle-size.md (mui#33109)

Co-authored-by: Marija Najdova <mnajdova@gmail.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
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 package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants