docs: tidy readme prose - #41
Merged
Merged
Conversation
- Separate linting/formatting (ruff) from type checking (ty) - Sentence-case headings and fix the skipped heading level - Replace em dashes in the description and the why-this-repo section
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
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
Readme prose fixes. No code or metadata changes.
Changes
ruff, type checking withty".#title) and "### Aftergit clonerun" became##.modern-python" footer is left as is; the same line appears in 24 org readmes.Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packagingTests ran against a throwaway postgres:17 container: 110 passed at 100% coverage, plus 4 migration tests.