Clarify formatter choice and fix CI doctrine job#127
Open
monkeypants wants to merge 1 commit into
Open
Conversation
The project uses black for formatting and ruff for linting, but this was not documented anywhere. Add a comment to [tool.ruff] in pyproject.toml making this explicit. The CI doctrine job ran bare `pytest` instead of `uv run pytest`, causing failures on systems where the system Python lacks tomllib (pre-3.11). Use uv run for consistency with the other CI jobs. Fixes #126
This was referenced Mar 26, 2026
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
[tool.ruff]in pyproject.toml documenting that ruff is for linting only and black handles formattinguv run pytestinstead of barepytest, which fails when the system Python is <3.11 (missingtomllib)Context
The project uses both black and ruff as dev dependencies, which creates ambiguity about which formatter is canonical.
ruff format --checkreports 22 files diverging from ruff's opinions even though black is happy with everything — these are genuine opinion differences between the two tools, not formatting violations.Michael's workflow uses black (commit messages reference "black formatting"), and the Makefile already uses
black --checkinlint-python. This PR makes that choice explicit.Test plan
ruff checkpassesblack --checkpassesFixes #126