Repository navigation
feat: enable Coder.LatinAbbreviations Vale rule - #30794
Merged
nickvigilante merged 2 commits intoOct 24, 2026
Merged
nickvigilante merged 2 commits into
nickvigilante merged 2 commits into
Conversation
Contributor
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
marked this pull request as ready for review
October 23, 2026 05:19
nickvigilante
force-pushed
the
vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion
branch
2 times, most recently
from
October 24, 2026 03:38
2d27cd4 to
423c2cb
Compare
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
force-pushed
the
vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion
branch
from
October 24, 2026 05:19
423c2cb to
0f09759
Compare
nickvigilante
deleted the
vigilante/docs-450-add-coderlatinabbreviations-vale-rule-suggestion
branch
October 24, 2026 05:27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Builds on #30782, which is merged; the branch now merges
main.Adds
Coder.LatinAbbreviations, a Vale rule that enforces Latin abbreviations.e.g.,i.e., andetc., includingeg.,ie., and a missing final period (e.g).suggestion. Scope:docs/**exceptdocs/.style/style-guide/**, limited to paragraphs, lists, headings, and blockquotes. Table cells and code are skipped.mainalready rewrote or removed some of the lines, andparameters.mdwas deleted onmain.vs.andet al.aren't flagged.Commits:
docs(docs): use English forms of Latin abbreviationsfeat(docs/.style): enable Coder.LatinAbbreviations Vale ruleGenerated pages:
.vale.iniskipsdocs/reference/{api,cli}/*.mdanddocs/admin/setup/configuration-reference.mdfor this rule, as it does forCoder.UnitSpacing.Their prose comes from CLI flag help text and Swagger comments in Go source, and
make genrewrites them, so a hand edit fails thegencheck (an earlier revision of this PR editedconfiguration-reference.mdand failedgenfor 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 scopeparagraphskips list items, blockquotes, and headings, so all four are listed. Table cells have their own scope and stay excluded.[Ee]and[Ii]classes withignorecase: false, so sentence-initialE.g.,still matches but the browser nameIE.doesn't.eg.andie.require the trailing period so ordinary words and file extensions stay quiet.e.g.andi.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 whenetc.closed the sentence.Test cases (fixtures under
/tmp/latin-test/, not committed), run with LF and CRLF line endings:e.g.,in a paragraph,i.e.,,etc.at the end of a sentence and before a comma,eg.,ie.,e.gandi.ewithout the final period,E.g.,,I.e.,,Etc., a blockquote, a list item, a numbered item, and a heading.e.g.,,i.e.,, andetc., code spans, a fenced block, "for example", "that is", "and so on",IE.,genre,series,egg,tie,etcetera,vs.,et al..path/i.e/xoutside code matches. It doesn't occur in the corpus.Checks:
vale --output=line docs/: 0Coder.LatinAbbreviationsfindings.go run ./scripts/styleclaimspasses.Generated by Coder Agents on behalf of @nickvigilante.