The README section 'Usage' mentions example code that does not exist.

[HenryHall]

Pre-Checks

• Follow our Code of Conduct.
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Make sure this is a Faker issue and not related to a combination with another package.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.
• I am willing to provide a PR.

Describe the bug

https://github.com/faker-js/faker/blob/next/README.md?plain=1#L84

The above link directs to a README line which mentions a commented out bit of code for importing faker from a single locale. However that bit of code does not exist!

Minimal reproduction code

No response

Additional Context

No response

Environment Info

N/A

Which module system do you use?

• CJS
• ESM

Used Package Manager

npm

[matthewmayer]

We could probably remove this whole paragraph, it's already explained better at https://fakerjs.dev/guide/localization.html#individual-localized-packages:

The above code indicates a basic usage of Faker.
The point of interest is the import statements at the top.
The first import indicates how one can import the entirety of Faker, which includes every locale, while the commented-out import showcases how to import only a single locale.
In most situations, importing a single locale is preferable for performance because some testing frameworks reload imports for every test file, which causes startup latencies to add up quickly.
Thus, limiting the import to a single locale can speed up startup times.

[HenryHall]

It looks like it was intentionally included in this section of the readme to 'hint' at options for better performance.

[ST-DDT]

Sorry, for the late response.
The section is indeed outdated and should be removed, because since v8.0 faker instances only contain a single locale and not multiple as before.

Will be fixed in #2433

• docs: fix outdated comment regarding multiple faker locales #2433