[CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores#296
[CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores#296
Conversation
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
🚀 Overture Maps docs branch preview deployed!You can review your changes at https://staging.overturemaps.org/docs/pr/296/index.html ♻️ Last refreshed: 2026-03-12T22:35:05Z |
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
There was a problem hiding this comment.
Pull request overview
Addresses recent lint failures in the schema reference documentation by aligning terminology with textlint expectations and adjusting markdownlint configuration to better handle generated/reference content.
Changes:
- Fixes textlint terminology violations across multiple schema reference markdown files (e.g., “Key/value” → “Key-value”, “Id” → “ID”, “snake case” → “snake_case”).
- Adds a
.markdownlintignoreentry to exclude generated schema reference docs from markdownlint. - Disables additional markdownlint rules in
.markdownlint.json(MD031, MD032, MD034, MD060).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/schema/reference/system/snake_case_string.md | Updates terminology to snake_case to satisfy textlint. |
| docs/schema/reference/system/ref/id.md | Adjusts heading terminology from “Id” to “ID”. |
| docs/schema/reference/places/place.md | Rewords websites field description to satisfy textlint terminology. |
| docs/schema/reference/base/water.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/reference/base/types/source_tags.md | Updates type description terminology to “Key-value”. |
| docs/schema/reference/base/land_use.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/reference/base/land.md | Updates “TODO” to “Todo” in prose to satisfy textlint. |
| docs/schema/reference/base/infrastructure.md | Updates source_tags description from “Key/value” to “Key-value”. |
| docs/schema/index.md | Updates “key/value” to “key-value” and removes extraneous blank line/whitespace. |
| .markdownlintignore | Ignores generated schema reference docs path for markdownlint. |
| .markdownlint.json | Disables additional markdownlint rules (MD031, MD032, MD034, MD060). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| In Overture data releases, land features are sourced from OpenStreetMap. Todo. Finish this when | ||
| I get more info from Jennings. |
There was a problem hiding this comment.
The placeholder sentence reads awkwardly as two fragments ("Todo. Finish this when …"). Consider rephrasing into a single sentence (e.g., "Todo: finish this when …") to improve readability while still complying with the terminology rule.
| | `taxonomy.alternates` | `list<`[`SnakeCaseString`](../system/snake_case_string.md)`>` (optional) | Unordered list of additional categories that are known for this place but that are not part of the primary category hierarchy.<br/><br/>Alternate categories allow a more complete picture of the place to be surfaced when it fits multiple unconnected branches in the taxonomy. For example a gas station that also sells groceries might have primary category of "gas_station" with an alternate of "grocery_store".<br/><br/>Alternate categories are not part of the primary hierarchy or another alternate category's hierarchy. In other words, if a category is a parent in the hierarchy of another category, that category can't be a primary or alternate category itself.<br/><br/>Note as well that this field is an unordered list of extra categories and does not represent a hierarchy. | | ||
| | `confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | A score between 0 and 1 indicating how confident we are that the place exists.<br/><br/>A confidence score of 0 indicates that we are certain the place doesn't exist anymore and will always be paired with an `operating_status` of `"permanently_closed"`.<br/><br/>A confidence score of 1 indicates that we are certain the place does exist.<br/><br/>If there is no value for confidence, it means we don't have enough information on which to estimate our confidence level. | | ||
| | `websites` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The websites of the place.<br/><br/>*Minimum length: 1*<br/>*All items must be unique. (`UniqueItemsConstraint`)* | | ||
| | `websites` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The sites of the place.<br/><br/>*Minimum length: 1*<br/>*All items must be unique. (`UniqueItemsConstraint`)* | |
There was a problem hiding this comment.
"The sites of the place" is ambiguous (could be read as physical sites). Consider wording that makes it explicit these are web URLs (e.g., "The site URLs for the place") while still avoiding the term that textlint flags.
| | `websites` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The sites of the place.<br/><br/>*Minimum length: 1*<br/>*All items must be unique. (`UniqueItemsConstraint`)* | | |
| | `websites` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The website URLs for the place.<br/><br/>*Minimum length: 1*<br/>*All items must be unique. (`UniqueItemsConstraint`)* | |
Pull Request
Fixes 11 textlint terminology errors across schema reference docs and expands the markdownlint ignore list with rules MD031, MD032, MD034, and MD060.
Terminology fixes:
Key/value→Key-value/key-value(land.md,land_use.md,infrastructure.md,water.md,source_tags.md,schema/index.md)TODO→Todo(land.md)websites→sitesin description text (place.md)# Id→# ID(ref/id.md)snake case→snake_case(2 occurrences insnake_case_string.md).markdownlint.jsonadditions:MD031,MD032,MD034,MD060Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.