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

docs: clarify that location.state refers to ISO 3166-2 #2574

Merged
merged 3 commits into from Dec 12, 2023
Merged

docs: clarify that location.state refers to ISO 3166-2 #2574

merged 3 commits into from Dec 12, 2023

Conversation

import-brain
Copy link
Member

closes #2360

This PR makes the docs of location.state() slightly more precise by explaining that the method generally returns the ISO 3166-2 subdivisions for a country.

@import-brain import-brain added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: location Something is referring to the location module labels Dec 11, 2023
@import-brain import-brain added this to the vAnytime milestone Dec 11, 2023
@import-brain import-brain requested a review from a team December 11, 2023 03:55
@import-brain import-brain self-assigned this Dec 11, 2023
@import-brain import-brain requested a review from a team as a code owner December 11, 2023 03:55
@codecov Codecov
Copy link

codecov bot commented Dec 11, 2023 •
edited

Codecov Report

Merging #2574 (cd333d1) into next (1631115) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             next    #2574   +/-   ##
=======================================
  Coverage   99.57%   99.57%           
=======================================
  Files        2806     2806           
  Lines      250192   250195    +3     
  Branches     1107     1107           
=======================================
+ Hits       249137   249142    +5     
+ Misses       1027     1025    -2     
  Partials       28       28
Files Coverage Δ
src/modules/location/index.ts 99.20% <100.00%> (+<0.01%) ⬆️

... and 1 file with indirect coverage changes

@ST-DDT
Copy link
Member

ST-DDT commented Dec 11, 2023

Does this also fixes #1944

ST-DDT
ST-DDT approved these changes Dec 11, 2023
View reviewed changes
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we put these description parts also on the locale definitions?

src/modules/location/index.ts Show resolved Hide resolved
@ST-DDT ST-DDT merged commit 8013fa0 into next Dec 12, 2023
20 checks passed
@ST-DDT ST-DDT deleted the docs/state_refer_to_iso_3166_2 branch December 12, 2023 22:50
@xDivisionByZerox xDivisionByZerox mentioned this pull request May 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ST-DDT ST-DDT ST-DDT approved these changes

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

@matthewmayer matthewmayer Awaiting requested review from matthewmayer

Assignees

@import-brain import-brain

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

Successfully merging this pull request may close these issues.

Clarify that location state refers to ISO 3166-2
4 participants
@import-brain @ST-DDT @matthewmayer @xDivisionByZerox