diff --git a/docs/Prose-Style-Guidelines.md b/docs/Prose-Style-Guidelines.md index 0b79bbfebb866b76b8cd0d6348476d140878e27f..5b2eabeec0789ee2b65b28f28b0eede1568b16ca 100644 --- a/docs/Prose-Style-Guidelines.md +++ b/docs/Prose-Style-Guidelines.md @@ -41,7 +41,7 @@ We prefer: ### Structure and markup -* Sentence case in section headings, not Title Case +* Title Case in `h1` headings; sentence case in all other headings * Periods at the ends of list items where most items in that list are complete sentences * More generally, parallel list item structure * Capitalise all list items if you want, even if they're not complete sentences; just be consistent within each list, and preferably, throughout the whole page diff --git a/docs/vale-styles/Homebrew/Titles.yml b/docs/vale-styles/Homebrew/Titles.yml index f54498fc22ad3f7b17a6d1c5f31fae175352ec94..f546c7e745a715f1e3a73ddaea1d1af10b748f30 100644 --- a/docs/vale-styles/Homebrew/Titles.yml +++ b/docs/vale-styles/Homebrew/Titles.yml @@ -1,6 +1,10 @@ ---- extends: capitalization -message: "'%s' should be in sentence case" +message: "'%s' should be in title case" level: warning -scope: heading -match: $sentence +scope: heading.h1 +match: $title +style: AP +exceptions: + - brew(1) + - Homebrew/homebrew-core + - Homebrew/linuxbrew-core