Skip to content

Commit 91ff9d5

Browse files
committed
style: align Vale heading comments with the sentence-case standard
Fallout from rebasing onto master: Pulumi.HeadingSentenceCase and its .vale.ini entry both described Title Case H1 as the convention, which now contradicts AGENTS.md and STYLE-GUIDE.md. Restate the comments as what the scoping actually is — sentence case is the standard at every level; the rule stays scoped to H2+ so it doesn't flag the backlog of Title Case front-matter titles. No rule behavior changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015KpCy5B47c2oNqEeX1Znwx
1 parent 8f96965 commit 91ff9d5

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

.vale.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ TokenIgnores = ({{[%<].*?[%>]}}), \
2020

2121
# Disable Google rules that conflict with Pulumi house style (brand.pulumi.com
2222
# is the source of truth; these mirror its writing-style/voice sections offline).
23-
Google.Headings = NO # Replaced by Pulumi.HeadingSentenceCase, which scopes to H2+ only (Pulumi uses Title Case for the H1/page title). Nothing else enforced H2 case — markdownlint has no sentence-case rule.
23+
Google.Headings = NO # Replaced by Pulumi.HeadingSentenceCase. The brand standard is sentence case at every level, but the rule is scoped to H2+ so it doesn't flag the backlog of existing Title Case H1s (front-matter `title`) during migration. Nothing else enforced H2 case — markdownlint has no sentence-case rule.
2424
Google.Quotes = NO # Brand puts commas/periods OUTSIDE closing quotes (logical style); Google's rule forces them inside.
2525
Google.WordList = NO # Google product-name overrides don't match Pulumi terminology.
2626
Google.We = NO # Blanket first-person flagger; replaced by Pulumi.NarrativeWe, which targets only narrative-walkthrough constructions (let's / we'll / now we ...), not every 'we'.

styles/Pulumi/HeadingSentenceCase.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ extends: capitalization
22
message: "Heading '%s' should use sentence case (capitalize only the first word and proper nouns)."
33
link: STYLE-GUIDE.md
44
level: warning
5-
# H2+ only. Pulumi convention is Title Case for the H1/page title and sentence
6-
# case for every subheading; Vale's per-level heading scopes let us enforce the
7-
# latter without touching H1. (Google.Headings is disabled in .vale.ini because
8-
# it has no level scope and would false-flag every Title-Case H1.)
5+
# H2+ only. The brand standard is sentence case at every level, page title
6+
# included, but enforcing it on H1 would flag the large backlog of existing
7+
# Title Case front-matter titles; Vale's per-level heading scopes let us
8+
# enforce the subheadings now and migrate H1s separately. (Google.Headings is
9+
# disabled in .vale.ini because it has no level scope.)
910
scope:
1011
- heading.h2
1112
- heading.h3

0 commit comments

Comments
 (0)