Repository navigation
PYTHON-6263 Remove the blacken-docs pre-commit hook - #3214
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the removal of the documentation-formatting hook and obsolete skip markers.
No open issues 🎉
What changed in this PR
Removes the documentation-formatting hook that used pinned Black 22.3.0 alongside the repository’s Ruff formatter, addressing the unwanted documentation rewrites reported in #3131.
Changes:
- Removes the
blacken-docspre-commit hook and its Black dependency. - Removes obsolete skip-marker comments from the coding standards without changing the guidance.
| File | Description |
|---|---|
CODING-STANDARDS.md |
Removes the unused blacken-docs:off/on comments. |
.pre-commit-config.yaml |
Removes the blacken-docs hook and pinned Black dependency. |
Review effort: Balanced
|
We should turn on ruff's markdown code formatting and docstring formatting if we remove |
We should, but I'm not sure that it should be done in this PR, because the replacement is not equivalent to what it replaces:
If we do everything in this PR and the doctest job fails after the PR merges the fix is to |
Sounds good, can you open a follow-up ticket to turn on |
PYTHON-6263
Changes in this PR
blacken-docshook from.pre-commit-config.yaml.blacken-docs:off/onskip markers fromCODING-STANDARDS.md.The hook formatted code samples in docs with the pinned black 22.3.0 while the repo formatter is ruff, and it failed the static job on #3131 by rewriting
CONTRIBUTING.md.Test Plan
uvx pre-commit run --all-files --hook-stage manualpasses.Checklist
Checklist for Author
Checklist for Reviewer