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: include hints on specifying a locale can help startup time #1629

Merged
merged 9 commits into from
Dec 7, 2022

Conversation

conner-c
Copy link
Contributor

@conner-c conner-c commented Dec 5, 2022

Updated: README.md to include a quick message about why loading every locale can slow down startup times.
Updated: localization.md includes more information about the limitations of some locales.
Updated: usage.md includes hints on how to specify a specific locale and why it can help startup times.
closes #1114

Updated: README.md to include a quick message why loading every locale can slow down startup times.
Updated: localization.md includes more information about the limitations of some locales.
Updated: usage.md includes hints on how to specify a specific locale and why it can help startup times.
@conner-c conner-c requested a review from a team December 5, 2022 04:15
@conner-c conner-c requested a review from a team as a code owner December 5, 2022 04:15
@Shinigami92 Shinigami92 changed the title docs: Include hints on my specifying a locale can help startup time docs: include hints on specifying a locale can help startup time Dec 5, 2022
@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Dec 5, 2022
@codecov
Copy link

codecov bot commented Dec 5, 2022

Codecov Report

Merging #1629 (495cef2) into next (f06126a) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 495cef2 differs from pull request most recent head 0ef885a. Consider uploading reports for the commit 0ef885a to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #1629      +/-   ##
==========================================
- Coverage   99.63%   99.62%   -0.02%     
==========================================
  Files        2222     2222              
  Lines      240500   240434      -66     
  Branches     1070     1064       -6     
==========================================
- Hits       239622   239532      -90     
- Misses        857      881      +24     
  Partials       21       21              
Impacted Files Coverage Δ
src/modules/internet/user-agent.ts 84.05% <0.00%> (-6.49%) ⬇️
src/modules/helpers/index.ts 98.55% <0.00%> (-0.06%) ⬇️
src/modules/date/index.ts 99.59% <0.00%> (-0.01%) ⬇️
src/modules/lorem/index.ts 100.00% <0.00%> (ø)
src/modules/string/index.ts 100.00% <0.00%> (ø)
src/modules/system/index.ts 100.00% <0.00%> (ø)
src/modules/datatype/index.ts 100.00% <0.00%> (ø)
src/modules/internet/index.ts 100.00% <0.00%> (ø)
src/modules/random/index.ts 99.00% <0.00%> (+0.01%) ⬆️

Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Please put long sentences in a new line each.

@ST-DDT ST-DDT added the p: 1-normal Nothing urgent label Dec 5, 2022
Copy link
Contributor Author

@conner-c conner-c left a comment

Choose a reason for hiding this comment

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

Updated files with given notes. I have separated the sentences into individual lines. I have rephrased sections.

Co-authored-by: ST-DDT <[email protected]>
ST-DDT
ST-DDT previously approved these changes Dec 6, 2022
@ST-DDT ST-DDT requested review from a team December 6, 2022 23:30
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

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

This should be very helpful. Thank you.

@ST-DDT ST-DDT requested review from a team December 7, 2022 09:56
@Shinigami92 Shinigami92 enabled auto-merge (squash) December 7, 2022 20:30
@Shinigami92 Shinigami92 merged commit d0ff3fe into faker-js:next Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

this package was slowing down my jest tests
5 participants