Skip to content

feat: enable Coder.AcronymPeriods Vale rule - #31180

Merged
nickvigilante merged 1 commit into
mainfrom
superblink/docs-430-add-coderacronymperiods-vale-rule
Oct 23, 2026
Merged

nickvigilante merged 1 commit into
mainfrom
superblink/docs-430-add-coderacronymperiods-vale-rule

Conversation

@coder

@coder coder Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Note

Recreated from #30783 under coder[bot] by Superblink, at the request of @nickvigilante, so he can review and merge it. An AI agent wrote the original, which was opened from his account. The diff is identical to #30783, squashed onto current main. Superblink reviewed it and ran Vale over docs/ before opening this PR (no new warnings or errors). #30783 should be closed in favor of this one.
Stack: this is the bottom of a 6-PR stack (#31180 → #31181 → #31182 → #31183 → #31184 → #31185). Merge them in that order.

Depends on #30782.

Adds Coder.AcronymPeriods, a Vale rule that enforces No periods in acronyms.
It flags capitalized acronyms written with periods, such as A.P.I. or U.S..

  • Severity: warning.
  • Scope: docs/** except docs/.style/style-guide/**, with no other exclusions.
  • Baseline: 0 findings, including the generated docs/reference/{api,cli,agent-api} pages, so no cleanup commit.
  • The PR flips the guide footer to enforced, adds the checks-table row, and updates the coverage counts (10 tool-checked, 32 planned) and the tooling paragraph (10 of 87).
  • Known limitation: a version placeholder such as X.Y.Z in plain prose matches as "X.Y.". None exist outside code font today, and the guide asks for code font on placeholders, which Vale skips.

Linear: DOCS-430

Decision log
  • Pattern \b(?:[A-Z]\.){2,}. Google.Periods used {3,}, but U.S. is a two-letter case the guide's Don't example names, so the rule requires two or more pairs.
  • Google rules aren't loaded, so nothing needed turning off.
  • e.g. and i.e. can't match: the rule is case-sensitive and accepts capital letters only. A single initial such as J. Smith can't match either.
  • Existence rule, nonword: true, ignorecase: false, same shape as UnitSpacing.
  • Test fixtures (not committed) with both LF and CRLF endings:
    • Flags: A.P.I., U.S., E.U., and X.Y.Z in prose (reported as X.Y.).
    • Doesn't flag: API, US, e.g., i.e., etc., J. Smith, a.m., p.m., code spans, fenced code.
    • LF and CRLF reported identical findings.
  • Checks: vale docs/ reports 0 Coder.AcronymPeriods findings, go run ./scripts/styleclaims passes, and the pre-commit-light hook (markdownlint, emdash, style-claims) passes.

Generated by Coder Agents on behalf of @nickvigilante.

Created on behalf of @nickvigilante

@coder
coder Bot requested a review from nickvigilante as a code owner October 23, 2026 08:30
@linear-code

linear-code Bot commented Oct 23, 2026

Copy link
Copy Markdown

DOCS-430

@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Oct 23, 2026
Recreated from #30783 under coder[bot] so it can be reviewed by its requester.
@coder
coder Bot force-pushed the superblink/docs-430-add-coderacronymperiods-vale-rule branch from b81ab71 to 2fb7f71 Compare October 23, 2026 08:36
coder Bot pushed a commit that referenced this pull request Oct 23, 2026
Recreated from #30786 under coder[bot] so it can be reviewed by its requester. Stacked on #31180.
@nickvigilante
nickvigilante enabled auto-merge (squash) October 23, 2026 15:51
@nickvigilante
nickvigilante merged commit c1bec1b into main Oct 23, 2026
33 checks passed
@nickvigilante
nickvigilante deleted the superblink/docs-430-add-coderacronymperiods-vale-rule branch October 23, 2026 15:56
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant