Skip to content

check_workflow_job_banners.py's docstring still names suppression-guard.yml, which #635 deleted #643

Description

@Yaraslaut

scripts/check_workflow_job_banners.py's docstring, in its "Scope" paragraph,
still lists suppression-guard.yml among the single-job workflows that have
never used the # ── banner style:

scripts/check_workflow_job_banners.py:50:suppression-guard.yml and the two wasm workflows are single-job files that have

That workflow no longer exists. #635 deleted it when it folded the
NOLINT-directive gate into drift-guard.yml's prose-lint job.

Verification status: reproduced on master @ c55ea5b7

The file is gone:

$ ls .github/workflows/
ci.yml
docs.yml
drift-guard.yml
mutation.yml
spec-sync.yml
wasm-demo.yml
wasm-ladder.yml

And the docstring is the only surviving reference to it anywhere in the tree:

$ grep -rn "suppression-guard" --include='*.py' --include='*.sh' --include='*.yml' --include='*.md' . | grep -v '^./.git/'
scripts/check_workflow_job_banners.py:50:suppression-guard.yml and the two wasm workflows are single-job files that have

Not verified: nothing about the gate's behaviour. The list in that
paragraph is prose explaining a rule that is derived from each file at run time
("Workflows that contain no banner at all are skipped, and that is derived from
the file rather than listed here"), so a name in it is documentation, not data,
and python3 scripts/check_workflow_job_banners.py . passes today. I did not
read the checker looking for any other use of the name; grep says there is
none.

Why it is worth a line

The defect is small and the irony is the point: a stale fact inside a gate
whose whole subject is stale facts. It sits in the paragraph a reader goes to
when asking "why is my new single-job workflow not being checked?", where a
name that no longer resolves makes the derivation rule harder to trust rather
than easier.

Found while reading the two most recent lint patterns before writing #628's
raw-bidi-control gate. Filed rather than folded, per AGENTS.md: it does not
belong to that change.

What would change the verdict

Close when the name is removed from the paragraph, or replaced by one of the
files that is actually in the tree. Re-open if suppression-guard.yml comes
back.

🤖 Generated with Claude Code

https://claude.ai/code/session_01VptDWG2fKr2vBnLSJcgzgW

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: ciSubsystem: cidocumentationImprovements or additions to documentationtriage: validWell-framed; implement as written

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions