Repository navigation
Switch off riscv.Spacing: it flags wrapped indented lists - #176
Merged
Merged
Conversation
Vale fails on this repository's own content. `riscv.Spacing` wants
exactly one space between words and reports any run of whitespace after
a full stop, but Vale lints the Asciidoctor-converted text, where a line
break plus a list item's continuation indent collapses into several
spaces. Ordinary wrapped prose inside an indented list is therefore
flagged even though nobody typed a double space:
README.adoc 46:85 'Actions. Do'
README.adoc 47:180 'behind. The'
README.adoc 48:410 'intervention. Set'
README.adoc 49:424 'recur. Pages'
modules/ROOT/pages/chapter2.adoc 60:44 'site. Diam'
All five are false positives. The README hits are the numbered
Repository Setup Checklist, where each continuation line is indented
three spaces as AsciiDoc requires; the chapter2.adoc hit is in the
sample spec content. Any adopting repository with a wrapped indented
list reproduces this.
The finding is also latent rather than reproducible, which makes it a
confusing gate to leave armed: the reusable workflow runs reviewdog with
`--filter-mode=diff_context`, so a pre-existing hit surfaces only when a
push's diff happens to cover it. Pushes to main on 2026-10-05 passed at
15:08 and 15:36 and failed at 20:24 with README.adoc untouched since
2026-09-30 -- see actions runs 37369566605 and 37369902949.
Switch the rule off alongside riscv.Slash and riscv.SentenceLength,
which are disabled for the same reason, and document why so nobody
re-enables it without re-reading this. Repositories that normalise their
prose to single spacing can of course turn it back on; the file already
documents the rule disables as the adopting repository's own.
riscv/riscv-high-assurance-cryptography reached the same conclusion
independently while adopting this config: the rule fired 242 times there,
50 of them on dotted notation (DSA.KeyGen, KEM.Encaps, SFENCE.VMA) read
as a sentence boundary.
Verified with Vale 3.23.0 using the workflow's own invocation
(`--minAlertLevel=error --glob='*.adoc'`): 5 errors before, 0 after,
across 9 files. All five were riscv.Spacing, so nothing else is masked.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Bill Traynor <wmat@riscv.org>
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.
Vale currently fails on this repository's own content — see actions runs
37369566605
and
37369902949.
riscv.Spacingwants exactly one space between words and reports any run ofwhitespace after a full stop. But Vale lints the Asciidoctor-converted text,
where a line break plus a list item's continuation indent collapses into several
spaces. Ordinary wrapped prose inside an indented list is therefore flagged even
though nobody typed a double space:
All five are false positives. The README hits are the numbered Repository
Setup Checklist, where each continuation line is indented three spaces as
AsciiDoc requires; the
chapter2.adochit is in the sample spec content. Anyadopting repository with a wrapped indented list reproduces this.
Why it looks intermittent
The reusable workflow runs reviewdog with
--filter-mode=diff_context, so apre-existing hit surfaces only when a push's diff happens to cover it. Pushes to
mainon 2026-10-05 passed at 15:08 and 15:36 and failed at 20:24 withREADME.adocuntouched since 2026-09-30. A gate that fires on unrelated pushesis worse than one that fires consistently.
Change
Switch the rule off alongside
riscv.Slashandriscv.SentenceLength, whichare disabled for the same reason, and document why so nobody re-enables it
without re-reading the rationale. Repositories that normalise their prose to
single spacing can turn it back on — the file already documents the rule
disables as the adopting repository's own.
riscv/riscv-high-assurance-cryptographyreached the same conclusionindependently while adopting this config: the rule fired 242 times there, 50 of
them on dotted notation (
DSA.KeyGen,KEM.Encaps,SFENCE.VMA) read as asentence boundary.
Verification
Vale 3.23.0 using the workflow's own invocation
(
--minAlertLevel=error --glob='*.adoc'): 5 errors before, 0 after, across 9files. All five were
riscv.Spacing, so nothing else is masked.🤖 Generated with Claude Code