Skip to content

feat: enable Coder.LatinAbbreviations Vale rule - #30794

Merged
nickvigilante merged 2 commits into
mainfrom
vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion
Oct 24, 2026
Merged

nickvigilante merged 2 commits into
mainfrom
vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Builds on #30782, which is merged; the branch now merges main.

Adds Coder.LatinAbbreviations, a Vale rule that enforces Latin abbreviations.

  • Suggests "for example", "that is", and "and so on" for e.g., i.e., and etc., including eg., ie., and a missing final period (e.g).
  • Severity: suggestion. Scope: docs/** except docs/.style/style-guide/**, limited to paragraphs, lists, headings, and blockquotes. Table cells and code are skipped.
  • Baseline: 170 findings in 91 files. The brief estimated 148.
  • Cleanup: 153 findings fixed across 81 hand-written pages, 0 left in linted pages. The count is lower than the original 158 because other PRs on main already rewrote or removed some of the lines, and parameters.md was deleted on main.
  • vs. and et al. aren't flagged.

Commits:

  1. docs(docs): use English forms of Latin abbreviations
  2. feat(docs/.style): enable Coder.LatinAbbreviations Vale rule

Generated pages: .vale.ini skips docs/reference/{api,cli}/*.md and docs/admin/setup/configuration-reference.md for this rule, as it does for Coder.UnitSpacing.
Their prose comes from CLI flag help text and Swagger comments in Go source, and make gen rewrites them, so a hand edit fails the gen check (an earlier revision of this PR edited configuration-reference.md and failed gen for that reason).
Cleaning them means editing Go and regenerating the help golden files and API docs, which is left for a follow-up.

Linear: DOCS-450

Decision log
  • extends: substitution, so the message names the replacement: "Consider 'for example' instead of 'e.g.'".
  • scope: [paragraph, list, heading, blockquote]. The single scope paragraph skips list items, blockquotes, and headings, so all four are listed. Table cells have their own scope and stay excluded.
  • Explicit [Ee] and [Ii] classes with ignorecase: false, so sentence-initial E.g., still matches but the browser name IE. doesn't.
  • eg. and ie. require the trailing period so ordinary words and file extensions stay quiet.
  • Cleanup rules, applied by script and then reviewed line by line:
    • e.g. and i.e. become "for example," and "that is," (capitalized at the start of a sentence), with a comma added when the original had none.
    • etc. becomes "and so on", with the sentence-ending period kept when etc. closed the sentence.
    • Lines inside table rows, fenced blocks, and code spans are untouched, so are the style guide and the generated pages.
    • Hard-wrapped lines keep their wrapping, and CRLF files keep CRLF.
  • The rest of the Vale output is unchanged: the per-rule counts for every other rule match the pre-cleanup run.

Test cases (fixtures under /tmp/latin-test/, not committed), run with LF and CRLF line endings:

  • Flagged (15 each): e.g., in a paragraph, i.e.,, etc. at the end of a sentence and before a comma, eg., ie., e.g and i.e without the final period, E.g.,, I.e.,, Etc., a blockquote, a list item, a numbered item, and a heading.
  • Not flagged: a table row with e.g.,, i.e.,, and etc., code spans, a fenced block, "for example", "that is", "and so on", IE., genre, series, egg, tie, etcetera, vs., et al..
  • Known edge case: a path-like token such as path/i.e/x outside code matches. It doesn't occur in the corpus.

Checks:

  • vale --output=line docs/: 0 Coder.LatinAbbreviations findings.
  • go run ./scripts/styleclaims passes.
  • The pre-commit-light hook passes on both commits.

Generated by Coder Agents on behalf of @nickvigilante.

@linear-code

linear-code Bot commented Oct 14, 2026

Copy link
Copy Markdown

DOCS-450

@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

Base automatically changed from vigilante/docs-1282-style-guide-add-missing-rules-from-the-docs-style-guide to main October 16, 2026 13:53
@nickvigilante nickvigilante changed the title feat(docs): enable Coder.LatinAbbreviations Vale rule feat: enable Coder.LatinAbbreviations Vale rule Oct 23, 2026
@nickvigilante
nickvigilante marked this pull request as ready for review October 23, 2026 05:19

@ianjevans ianjevans left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

@nickvigilante
nickvigilante force-pushed the vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion branch 2 times, most recently from 2d27cd4 to 423c2cb Compare October 24, 2026 03:38
Replaces "e.g.", "i.e.", and "etc." in running prose with "for example", "that is", and "and so on". Table cells, code, the style guide, and pages generated from Go source are unchanged.
Suggests the English form of e.g., i.e., and etc. in prose at suggestion severity and flips the style guide footer from planned to enforced.
@nickvigilante
nickvigilante force-pushed the vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion branch from 423c2cb to 0f09759 Compare October 24, 2026 05:19
@nickvigilante
nickvigilante merged commit 7eacfe9 into main Oct 24, 2026
28 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion branch October 24, 2026 05:27
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants