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

chore(location): Deprecate faker.location.county and make alias for faker.location.state #1945

Closed
wants to merge 1 commit into from
Closed

chore(location): Deprecate faker.location.county and make alias for faker.location.state #1945

wants to merge 1 commit into from

Conversation

matthewmayer
Copy link
Contributor

fix #1944

@matthewmayer matthewmayer requested a review from a team as a code owner March 17, 2023 08:45
@matthewmayer matthewmayer self-assigned this Mar 17, 2023
@codecov
Copy link

codecov bot commented Mar 17, 2023

Codecov Report

Merging #1945 (dcbc65c) into next (085562f) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             next    #1945   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2357     2354    -3     
  Lines      236856   236797   -59     
  Branches     1229     1227    -2     
=======================================
- Hits       235974   235919   -55     
+ Misses        860      856    -4     
  Partials       22       22
Impacted Files Coverage Δ
src/definitions/location.ts 0.00% <ø> (ø)
src/locales/el/location/state.ts 100.00% <ø> (ø)
src/locales/en/location/index.ts 100.00% <ø> (ø)
src/locales/en_GB/location/state.ts 100.00% <ø> (ø)
src/locales/en_IE/location/state.ts 100.00% <ø> (ø)
src/locales/he/location/index.ts 100.00% <ø> (ø)
src/locales/ro/location/index.ts 100.00% <ø> (ø)
src/modules/random/index.ts 100.00% <ø> (ø)
src/locales/el/location/index.ts 100.00% <100.00%> (ø)
src/locales/en_GB/location/index.ts 100.00% <100.00%> (ø)
... and 2 more

... and 1 file with indirect coverage changes

@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision m: location Something is referring to the location module deprecation A deprecation was made in the PR labels Mar 17, 2023
@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 closed this Mar 23, 2023
@ST-DDT ST-DDT added wontfix This will not be worked on and removed s: needs decision Needs team/maintainer decision labels Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@matthewmayer matthewmayer

Labels
deprecation A deprecation was made in the PR m: location Something is referring to the location module p: 1-normal Nothing urgent wontfix This will not be worked on
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.x
Development

Successfully merging this pull request may close these issues.

Clarify the difference between faker.location.county and faker.location.state
2 participants
@matthewmayer @ST-DDT