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.

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

Clarify that location state refers to ISO 3166-2 #2360

Closed
ST-DDT opened this issue Aug 31, 2023 · 3 comments · Fixed by #2574
Closed

Clarify that location state refers to ISO 3166-2 #2360

ST-DDT opened this issue Aug 31, 2023 · 3 comments · Fixed by #2574
Assignees
@ejcheng
Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers m: location Something is referring to the location module p: 1-normal Nothing urgent
Milestone
vAnytime

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Aug 31, 2023

Clear and concise description of the problem

Currently the definition of location.state is not very precise.

Suggested solution

Mention that it should refer to ISO_3166-2.

Alternative

No response

Additional context

No response
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Aug 31, 2023
@ST-DDT
Copy link
Member Author

ST-DDT commented Aug 31, 2023

There is one issue with at though:
The iso lists more than the 1. administrative level.
E.g. regions, capital city, territory, state, ...

@ST-DDT ST-DDT added the m: location Something is referring to the location module label Aug 31, 2023
@matthewmayer
Copy link
Contributor

I would put some wiggle room in the description. Something like "Generally these are the ISO 3166-2 subdivisions for a country".

Note not all locales have a country attached (e.g. en, ar, es)

@ST-DDT
Copy link
Member Author

ST-DDT commented Sep 1, 2023

Yeah, I had something similar in my mind:

State or first level admin area. Might take inspiration from ISO...

I'm not good at writing squishy definitions.

@xDivisionByZerox xDivisionByZerox added the good first issue Good for newcomers label Sep 1, 2023
@ejcheng ejcheng mentioned this issue Dec 11, 2023
Merged
@ejcheng ejcheng self-assigned this Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ejcheng ejcheng

Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers m: location Something is referring to the location module p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging a pull request may close this issue.

docs: clarify that location.state refers to ISO 3166-2 faker-js/faker
4 participants
@matthewmayer @ST-DDT @ejcheng @xDivisionByZerox