-
Notifications
You must be signed in to change notification settings - Fork 6
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
Switch from camelCase to snake_case #127
Conversation
ea6274d
to
b558e86
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Provided it passes validation and the docs build, let's get this merged down onto dev
so we can continue building on top of it.
counterexamples/transportation/segment/road/restrictions/bad-access-mode.yaml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like some class enum values in land and landuse still need to be converted.
9c07a05
9c07a05
to
1e193c3
Compare
This commit switches properties and enumerators from `camelCase` naming to `snake_case` naming. The purpose is to improve compatibility with SQL based tools. Because SQL uses case-insensitive identifiers for historical reasons, SQL-based tools cause problems and information loss with camel-casing because they tend to treat all identifiers as if they were alllowercase or ALLCAPS. In the Overture Schema Task Force meeting of 2024-02-07, the task force decided to adopt the snake_case proposal: OvertureMaps/schema-wg#272 The proposal originated in Jake's Schema Friction discussion document on the Overture Confluence: https://wiki.overturemaps.org/x/SQGAAQ While we believe that snake_case is slightly unconventional, and dare I (Vic) say also more unsightly in the JSON context, we feel that for SQL compatibility reasons, the pros of changing outweigh the cons.
Thanks for finding that. Fixed in my latest update. |
Description
Brief description of the business purpose and effect of the pull request.
This commit switches properties and enumerators from
camelCase
naming tosnake_case
naming throughout the schema.The purpose is to improve compatibility with SQL-based tools. Because SQL uses case-insensitive identifiers for historical reasons, SQL-based tools cause problems and information loss with camel-casing because they tend to treat all identifiers as if they were alllowercase or ALLCAPS.
In the Overture Schema Task Force meeting of 2024-02-07, the task force decided to adopt the snake_case proposal. The proposal originated in Jake's Schema Friction discussion document on the Overture Confluence.
While we believe that snake_case is slightly unconventional and, dare I (Vic) say also more unsightly in the JSON context, we feel that for SQL compatibility reasons, the pros of changing outweigh the cons.
Reference
List of relevant links to GitHub issues, PRs, and other documentation.
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.
ext_expected_errors
property to introduce some basic assertion sanity.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.
Documentation Website
Update the hyperlink below to put the pull request number in.
Docs preview for this PR.