Skip to content

Holidays issue-160 - Add region_names with iso 3166 english short names#325

Draft
ppeble wants to merge 8 commits into
holidays:masterfrom
ppeble:iso3166-region-names
Draft

Holidays issue-160 - Add region_names with iso 3166 english short names#325
ppeble wants to merge 8 commits into
holidays:masterfrom
ppeble:iso3166-region-names

Conversation

@ppeble
Copy link
Copy Markdown
Member

@ppeble ppeble commented Apr 22, 2026

This is in response to holidays/holidays#160

We are adding a 'name' to each of the regions. These are iso 3166 english short names (in general). We will then update the downstream repos so that they process these values for human consumption.

We assume that i18n libraries will be able to parse the region code or the english short name here since they are based on iso 3166. In the cases where we have non-standard regions/names we will need to take that on a case by case basis. Some of this will be legacy stuff that will be hard to unravel without breaking changes, and we will address those individually.

The validation that is added should ensure that the iso 3166 structure is maintained going forward. We will rely on countries for this.

I propose that this is NOT a breaking change since it additive, and then there will be a matching downstream ruby gem update to process these in a comprehensive way.

@ppeble ppeble force-pushed the iso3166-region-names branch from 7678d94 to 1494cba Compare April 22, 2026 05:39
@ppeble ppeble requested review from gregoryfm and ttwo32 April 22, 2026 05:41
@ppeble ppeble marked this pull request as draft April 22, 2026 05:41
ppeble added 8 commits April 22, 2026 01:28
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
Signed-off-by: Phil Peble <phil@peble.net>
@ppeble ppeble force-pushed the iso3166-region-names branch from 1494cba to 1e2e1bc Compare April 22, 2026 06:28
@ppeble ppeble self-assigned this Apr 30, 2026
Comment thread doc/SYNTAX.md
### Naming conventions

- **ISO 3166-1 countries** (e.g. `:gb`, `:fr`): use the ISO 3166-1 common English name (e.g. `gb` is `"United Kingdom"`, not `"United Kingdom of Great Britain and Northern Ireland"`)
- **ISO 3166-2 subdivisions** (e.g. `:gb_eng`, `:de_by`): use the ISO 3166-2 official name, note that ISO 3166-2 names are in the official language of the country, not necessarily English (e.g. `de_by` is `"Bayern"`, not `"Bavaria"`)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree this point. 👍

Copy link
Copy Markdown
Member

@ttwo32 ttwo32 left a comment

Choose a reason for hiding this comment

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

LGTM.:)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants