Skip to content

[CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores#296

Open
Copilot wants to merge 5 commits intomainfrom
copilot/fix-linter-errors
Open

[CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores#296
Copilot wants to merge 5 commits intomainfrom
copilot/fix-linter-errors

Conversation

Copy link
Contributor

Copilot AI commented Mar 12, 2026

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/valueKey-value / key-value (land.md, land_use.md, infrastructure.md, water.md, source_tags.md, schema/index.md)
  • TODOTodo (land.md)
  • websitessites in description text (place.md)
  • # Id# ID (ref/id.md)
  • snake casesnake_case (2 occurrences in snake_case_string.md)

.markdownlint.json additions:

  • Disabled: MD031, MD032, MD034, MD060
Original prompt

This section details on the original issue you should resolve

<issue_title>[TASK] Fix outstanding linter errors</issue_title>
<issue_description>We've got linting added recently, now it should be green! These are mostly minor text issues.

Fix:


/github/workspace/docs/schema/reference/base/land.md
  10:74  ✓ error  Incorrect term: “TODO”, use “Todo” instead            terminology
  56:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/land_use.md
  51:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/index.md
  29:67  ✓ error  Incorrect term: “key/value”, use “key-value” instead  terminology

/github/workspace/docs/schema/reference/base/types/source_tags.md
  3:1  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/infrastructure.md
  46:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/water.md
  67:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/places/place.md
  38:89  ✓ error  Incorrect term: “websites”, use “sites” instead  terminology

/github/workspace/docs/schema/reference/system/ref/id.md
  1:3  ✓ error  Incorrect term: “Id”, use “ID” instead  terminology

/github/workspace/docs/schema/reference/system/snake_case_string.md
  3:28  ✓ error  Incorrect term: “snake case”, use “snake_case” instead  terminology
  9:38  ✓ error  Incorrect term: “snake case”, use “snake_case” instead  terminology

✖ 11 problems (11 errors, 0 warnings, 0 infos)
✓ 11 fixable problems.
Try to run: $ textlint --fix [file]

And ignore the following markdown lint rules:

  • MD060
  • MD034</issue_description>

Comments on the Issue (you are Copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits March 12, 2026 22:24
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
Co-authored-by: lowlydba <16843041+lowlydba@users.noreply.github.com>
Copilot AI changed the title [WIP] [TASK] Fix outstanding linter errors Fix outstanding textlint terminology errors and expand markdownlint ignores Mar 12, 2026
@lowlydba John McCall (lowlydba) changed the title Fix outstanding textlint terminology errors and expand markdownlint ignores [CHORE] Fix outstanding textlint terminology errors and expand markdownlint ignores Mar 12, 2026
@github-actions
Copy link

github-actions bot commented Mar 12, 2026

🚀 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>
@lowlydba John McCall (lowlydba) marked this pull request as ready for review March 12, 2026 22:33
@lowlydba John McCall (lowlydba) requested a review from a team as a code owner March 12, 2026 22:33
Copilot AI review requested due to automatic review settings March 12, 2026 22:33
@github-actions
Copy link

Super-linter summary

Language Validation result
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 .markdownlintignore entry 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.

Comment on lines +10 to 11
In Overture data releases, land features are sourced from OpenStreetMap. Todo. Finish this when
I get more info from Jennings.
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
| `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`)* |
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

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

"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.

Suggested change
| `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`)* |

Copilot uses AI. Check for mistakes.
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.

[TASK] Fix outstanding linter errors

3 participants