Format Markdown Python examples with Ruff - #112
Merged
Conversation
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
1 participant
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.
Summary
Ruff 0.16 can format Python code blocks embedded in Markdown, so the formatter contract now covers those examples explicitly rather than only discovering them in ad hoc repository-wide runs.
The
ruff-formatpre-commit hook now includes Markdown files, while CI and the dependency canary both runruff format --check .. README-only changes also trigger CI. The six existing documentation files reported by Ruff have been reformatted without changing their prose or behavior.Validation
uv run ruff check --extend-select I,UP pyproject.toml src tests .github/scriptsuv run ruff format --check .(350 files already formatted)uv run --extra test pre-commit run --all-filesuv run pytest(1702 passed)uv run mkdocs build --strict