diff options
| author | Eric Cheng <[email protected]> | 2023-12-12 17:50:24 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-12-12 23:50:24 +0100 |
| commit | 8013fa0404ceea2636544606beba8c996add7d57 (patch) | |
| tree | f5049ef114172369881402bbf9996b8da0725b12 /src/modules | |
| parent | 1631115a6a9846c50473fe60ea5bdb7ce9d04084 (diff) | |
| download | faker-8013fa0404ceea2636544606beba8c996add7d57.tar.xz faker-8013fa0404ceea2636544606beba8c996add7d57.zip | |
docs: clarify that location.state refers to ISO 3166-2 (#2574)
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/location/index.ts | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts index e7bde32e..6d15741d 100644 --- a/src/modules/location/index.ts +++ b/src/modules/location/index.ts @@ -372,6 +372,9 @@ export class LocationModule extends ModuleBase { /** * Returns a random localized state, or other equivalent first-level administrative entity for the locale's country such as a province or region. + * Generally, these are the ISO 3166-2 subdivisions for a country. + * If a locale doesn't correspond to one specific country, the method may return ISO 3166-2 subdivisions from one or more countries that uses that language. For example, the `ar` locale includes subdivisions from Arabic-speaking countries, such as Tunisia, Algeria, Syria, Lebanon, etc. + * For historical compatibility reasons, the default `en` locale only includes states in the United States (identical to `en_US`). However, you can use other English locales, such as `en_IN`, `en_GB`, and `en_AU`, if needed. * * @param options An options object. * @param options.abbreviated If true this will return abbreviated first-level administrative entity names. |