Fix: drop the docs workflow's reference to a deleted hook - #1569
Conversation
The `mkdocs build --strict` step pointed readers at `docs/_hooks/griffe_filter.py` for "the one warning class that is deliberately not counted". That hook was removed once the annotations it worked around landed, so `docs/_hooks/` holds only `repo_links.py` and `mkdocs.yml` registers only that one. The strict build has no exemption left; the comment now says so. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation workflow comment now describes the failure modes enforced by ChangesDocumentation workflow
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
.github/workflows/docs.ymltold readers to seedocs/_hooks/griffe_filter.pyfor "the one warning class that is deliberately not counted" bymkdocs build --strict.That hook no longer exists — it was removed in #1546 once the type annotations it worked around landed.
docs/_hooks/now holds onlyrepo_links.py, andmkdocs.ymlregisters only that one. The strict build has no exempt warning class at all, so the comment both pointed at a missing file and understated the guarantee.Comment only — no behavior change.
Testing
grep -rIn griffe_filter .returns no remaining referencesdocs/_hooks/contains onlyrepo_links.py;mkdocs.ymlhooks:lists only that filedocsworkflow's own build job exercises the line this comment describes