gtfs-validator icon indicating copy to clipboard operation
gtfs-validator copied to clipboard

docs: remove unused suppress/anchor lines from NEW_RULES

Open PatrickSteil opened this issue 4 months ago • 3 comments

Summary:

This PR removes leftover lines from the documentation that caused formatting issues:

  • <!--suppress ALL -->: IDE-specific directive, not useful in NEW_RULES.md.
  • <a name="examples"/>: introduced an unclosed tag, which made GitHub render the following section underlined.

Problem: The unclosed <a> tag caused large portions of the NEW_RULES.md to appear underlined on GitHub, making it harder to read. See the image below:

Screenshot 2025-09-04 at 15 49 51

Notes:

  • No code changes, only documentation cleanup.

PatrickSteil avatar Sep 04 '25 13:09 PatrickSteil

Thanks for opening this pull request! You're awesome. We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix. Examples of titles with semantic prefixes:

  • fix: Bug with ssl network connections + Java module permissions.
  • feat: Initial support for multiple @PrimaryKey annotations.
  • docs: update RELEASE.md with new process To get this PR to the finish line, please do the following:
  • Read our Contribution Guidelines
  • Follow Google Java style coding standards
  • Include tests when adding/changing behavior
  • Include screenshots

welcome[bot] avatar Sep 04 '25 13:09 welcome[bot]

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Sep 04 '25 13:09 CLAassistant

Hi @PatrickSteil! Thanks for this great contribution and apologies for it slipping our notice in the midst of getting on top of emails after summer vacations. We plan to take a look soon.

emmambd avatar Sep 24 '25 17:09 emmambd