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

Delete primary sub-property from division's local_type #139

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

vcschapp
Copy link
Collaborator

@vcschapp vcschapp commented Mar 4, 2024

Description

Brief description of the business purpose and effect of the pull request.

This change deletes the primary sub-property from a division's local_type property and deletes a redundant level of nesting.

Before

local_type:
  primary: territory
  common:
    en: territory
    fr: territoire

After

local_type:
  en: territory
  fr: territoire

Reference

List of relevant links to GitHub issues, PRs, and other documentation.

  1. The decision to make this change was made in the Admin Task Force meeting of 2024-03-04 as a fast-follow on the main Divisions PR.
  2. The reason for making the change is that we couldn't articulate a good objective basis for favoring one translation over another as "primary" and felt that doing so could lead to unnecessary controversy in multi-lingual jurisdictions. We felt that it is a different situation than with the "primary" name of the names structure because the name of a feature is much more local and primary preferences should tend to even out, whereas with local_type we would want to be able to have a single "national" policy to make the data programmatically friendly. But a single policy would tend to globally prefer one translation over another so we decided to drop "primary" instead.

Testing

Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.

Updated examples and counterexamples.

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  4. Update Docusaurus documentation, if an update is required.
  5. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation Website

Update the hyperlink below to put the pull request number in.

Docs preview for this PR.

This small change is as agreed in the Admins Task Force meeting of
2024-03-04: OvertureMaps/tf-admin#51. The
Task Force decided that picking a primary name for the localized region
type might be difficult in multi-lingual contexts and the the simplest
approach is to drop the `local_type.primary` sub-property altogether.
Copy link
Collaborator

@jwass jwass left a comment

Choose a reason for hiding this comment

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

Looks good to me

@vcschapp vcschapp merged commit debb0c4 into dev Mar 6, 2024
2 checks passed
@vcschapp vcschapp deleted the divisions_local_type branch March 6, 2024 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants