Skip to content

Document how to use locales #1322

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
Closed
Shinigami92 opened this issue Sep 2, 2022 · 0 comments · Fixed by #1364
Closed

Document how to use locales #1322

Shinigami92 opened this issue Sep 2, 2022 · 0 comments · Fixed by #1364
Assignees
@Shinigami92
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone
v7 - Current Major

Comments

@Shinigami92
Copy link
Member

Shinigami92 commented Sep 2, 2022 •
edited
Loading

We would like to have a dedicated section in our docs that explains how locales are used in faker.
Starting from how faker.setLocale works to why users can benefit from using import { faker } from '@faker-js/faker/locale/<key>'

Currently we only point to these locales in our README.md in the usage section and in the v5->v6 migration guide
But that's definitely not enough and needs more details in the new docs
@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Sep 2, 2022
@Shinigami92 Shinigami92 added this to the v7 - Current Major milestone Sep 2, 2022
@Shinigami92 Shinigami92 moved this to Todo in Faker Roadmap Sep 2, 2022
@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Sep 2, 2022
@ST-DDT ST-DDT mentioned this issue Sep 6, 2022
Closed
@Shinigami92 Shinigami92 mentioned this issue Sep 10, 2022
Merged
@Shinigami92 Shinigami92 self-assigned this Sep 10, 2022
@Shinigami92 Shinigami92 moved this from Todo to In Progress in Faker Roadmap Sep 10, 2022
@Shinigami92 Shinigami92 moved this from In Progress to Awaiting Review in Faker Roadmap Sep 10, 2022
Repository owner moved this from Awaiting Review to Done in Faker Roadmap Sep 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shinigami92 Shinigami92

Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v7 - Current Major
Development

Successfully merging a pull request may close this issue.

docs: localization faker-js/faker
2 participants
@ST-DDT @Shinigami92