diff --git a/.github/workflows/validate-task.yml b/.github/workflows/validate-task.yml index 96451b0e..a26b53bf 100644 --- a/.github/workflows/validate-task.yml +++ b/.github/workflows/validate-task.yml @@ -68,8 +68,8 @@ jobs: - name: Check repo gates step run: python3 scripts/repo_gate.py - # Every default prose rule is clean tree-wide, so each one gates rather than reporting a backlog. - # `charset-unknown` is clean too and still reports, for the reason the step below gives. + # Every default prose rule is clean tree-wide, so all but one block a change that adds a finding. + # `charset-unknown` is the exception and reports in the step below, for the reason given there. - name: Check prose step run: python3 scripts/prose_lint.py . --check charset --check semicolon --check dash --check dupword --check spelling --check comment-wrap --check comment-case --check home-path diff --git a/scripts/README.md b/scripts/README.md index b5d23876..b0315e89 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -72,7 +72,7 @@ A comment sentence also has to start with a capital, which `comment-case` checks **A comment whose whole body is a URI is a reference rather than a sentence**, and neither rule applies to it. It cannot be capitalized or restructured without corrupting the address it exists to carry, so before the exemption every repo carrying a reference block inherited a finding no edit could answer. Consecutive reference lines are separate addresses rather than one sentence wrapping, which is why the exemption also stops the line below a URI from reading as its continuation. A URI inside a sentence is still prose, so the exemption requires the whole body to be the address and nothing else. -Every rule in the default set is clean tree-wide, which is what lets CI gate them over the whole tree rather than over a diff. `charset-unknown` reports instead of blocking, for the reason the tier discussion above gives. +Every rule in the default set is clean tree-wide, which is what lets the CI gate read the whole tree rather than a diff. `charset-unknown` is the one that reports instead of blocking, for the reason the tier discussion above gives. ## `repo_gate.py`