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

Clarify the difference between faker.location.county and faker.location.state #1944

Closed
matthewmayer opened this issue Mar 17, 2023 · 5 comments
Labels
c: docs Improvements or additions to documentation c: locale Permutes locale definitions m: location Something is referring to the location module p: 1-normal Nothing urgent
Milestone

Comments

@matthewmayer
Copy link
Contributor

matthewmayer commented Mar 17, 2023

The top-level administrative regions of a country can be called states (eg. in USA), provinces (e.g. in Canada) or counties (e.g. in UK), or various other names.

Currently there are seperate methods called faker.location.state() and faker.location.county()

It's clearer to have a single method for this.
The following locales have county definitions

  • en, but it's a truncated version of the en_GB list
  • el -> rename to state
  • en_GB -> rename to state
  • en_IE -> rename to state
  • he -> contains a comment "Not relevant for Israel"
  • ro, but it's a duplicate of the state list
@matthewmayer matthewmayer changed the title Deprecate faker.location.county Deprecate faker.location.county and make alias for faker.location.state Mar 17, 2023
@ST-DDT
Copy link
Member

ST-DDT commented Mar 17, 2023

Isnt a county an adminstrative area within a state?

@ST-DDT ST-DDT added p: 1-normal Nothing urgent c: locale Permutes locale definitions m: location Something is referring to the location module labels Mar 17, 2023
@ST-DDT ST-DDT moved this to Awaiting Review in Faker Roadmap Mar 17, 2023
@ST-DDT ST-DDT moved this from Awaiting Review to Todo in Faker Roadmap Mar 17, 2023
@ST-DDT ST-DDT added the s: needs decision Needs team/maintainer decision label Mar 17, 2023
@matthewmayer
Copy link
Contributor Author

Isnt a county an adminstrative area within a state?

Not consistently.
In the US yes in most states, but you dont write the county in a postal address.

@ST-DDT
Copy link
Member

ST-DDT commented Mar 23, 2023

Team Decision

We want to keep location.county().
We should however improve the documentation, that this usually refers to administrative areas within a state:

Country State County City
USA Alabama Baldwin Daphne
DE NRW Städteregion Aachen Würselen

@ST-DDT ST-DDT removed the s: needs decision Needs team/maintainer decision label Mar 23, 2023
@matthewmayer
Copy link
Contributor Author

Team Decision

We want to keep location.county().
We should however improve the documentation, that this usually refers to administrative areas within a state:

hmm, none of the current locales actually do this though. We don't have second-level administrative regions implemented anywhere.

@xDivisionByZerox
Copy link
Member

I'd consider this solved by #1987 and #2574. If you think this is a mistake, please write a comment or reopen the issue directly.

@xDivisionByZerox xDivisionByZerox added the c: docs Improvements or additions to documentation label May 5, 2024
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 c: locale Permutes locale definitions m: location Something is referring to the location module p: 1-normal Nothing urgent
Projects
No open projects
Status: Todo
3 participants