Skip to content

docs: tidy readme prose - #41

Merged
lesnik512 merged 2 commits into
mainfrom
docs/fix-facts
Oct 3, 2026
Merged

lesnik512 merged 2 commits into
mainfrom
docs/fix-facts

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

Readme prose fixes. No code or metadata changes.

Changes

  • readme.md:28 said ruff and ty do linting and formatting; ty is a type checker. Now "Linting and formatting with ruff, type checking with ty".
  • Headings: "Key Features" is sentence case; "### Description" (directly under the # title) and "### After git clone run" became ##.
  • readme.md:14-16: the em-dash aside became a colon list plus a separate sentence.
  • readme.md:46-49: "Nothing shows them composed under load-bearing decisions ..." rewritten as two plain sentences that keep the same three facts (transaction spanning two writes, unique constraint hit by concurrent requests, count that must not cost a row per event).
  • The em dash in the shared "Part of modern-python" footer is left as is; the same line appears in 24 org readmes.
  • Every path in the pattern table was checked and still exists.

Checklist

  • Lint and format pass (ruff)
  • Type check passes (ty)
  • Tests pass and new behavior is covered
  • Build succeeds (uv build) if packaging or build config changed
  • Repo metadata stays consistent across the three surfaces (GitHub description, pyproject description, profile blurb) if this touches packaging

Tests ran against a throwaway postgres:17 container: 110 passed at 100% coverage, plus 4 migration tests.

- 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
@lesnik512
lesnik512 merged commit 5f34a64 into main Oct 3, 2026
4 checks passed
@lesnik512
lesnik512 deleted the docs/fix-facts branch October 3, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant