Repository navigation
chore: allow multi-word proper nouns in the style checker's exceptions - #879
Open
sterlingkoch wants to merge 1 commit into
Open
sterlingkoch wants to merge 1 commit into
sterlingkoch wants to merge 1 commit into
Conversation
Headings such as "How Talos Director differs from vSphere" were flagged because "Director" is not a proper noun on its own. A line with several words in exceptions.txt is now a phrase whose words keep their capitals only together, and "Talos Director" is the first one, so a bare "Director" in a heading is still flagged. Signed-off-by: Sterling Koch <sterling.koch@siderolabs.com>
Iheanacho-ai
approved these changes
Oct 22, 2026
This branch has not been deployed
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
The style checker's exceptions list now accepts multi-word entries, and
Talos Directoris the first one.Why
Headings with the product name, such as "How Talos Director differs from vSphere," get a sentence-case warning because "Director" isn't in the exceptions list. Adding "Director" as a single word would also let a bare "Director" through, and the product name is always "Talos Director."
Change
main.go: a line inexceptions.txtwith several words is a phrase. Its words keep their capitals only together and in order. Single-word entries work as before.exceptions.txt: addsTalos Directorand explains phrases in the header.main_test.go: one test that "Talos Director" passes in a heading, one that "Director" alone is still flagged.README.md: documents phrases.Testing
go test,go vet,gofmt, and golangci-lint v2.12.2 intools/style-guide-checker; the checker on docs: add vSphere Concepts, Requirements, and API and Automation for Talos Director #860's vSphere Concepts and What Is Talos Director? pages, which now report no warnings.