Skip to content

Name the collation for reference-link definition sort order #583

Description

@ptr727

AGENTS.md "Documentation Style Conventions > Markdown" says reference-link definitions are "alphabetized by reference name". That is ambiguous wherever one label is a prefix of another, and the two readings disagree:

  • Sorting the full definition line, which is what plain sort does, puts [agents-write-safety] before [agents], because - (0x2D) sorts before ] (0x5D).
  • Sorting the bare label puts [agents] first.

The definition blocks in ESPHome-Config are consistently the first form and pass LC_ALL=C sort -c on every group. Copilot reviewed a PR touching one of those blocks and reported the order as an alphabetization defect, asking for a re-sort. Applying it would reorder [agents-write-safety] / [agents] and simultaneously break [rgb-led-status-template] / [rgb-led-status], since no single bare-label order satisfies both prefix pairs.

Naming the collation in the rule would settle it, for example "alphabetized by the full definition line (plain sort)". Whichever form is chosen, being explicit stops the comment recurring on every PR that touches a definition block.

Instance: ptr727/ESPHome-Config#80.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions