Skip to content

docs: fix README override example and wording - #61

Merged
lesnik512 merged 1 commit into
mainfrom
docs/fix-facts
Oct 3, 2026
Merged

lesnik512 merged 1 commit into
mainfrom
docs/fix-facts

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

README fixes from a docs review.

The Overrides example applied di_container.override(...) inside the test body, but user_service is a fixture that already resolved during setup (modern_di_pytest/factory.py, _fixture calls container.resolve_dependency eagerly). The assertion ran against the real repo. Reproduced as a pytest run: the old example fails with assert ['real'] == []; the new one passes.

Changes

  • Overrides: override di_container in the test module and apply the override there (with di_container.override(...)), so generated fixtures resolve against it
  • Replace the "3.1: graph validation is an explicit call now" comment with current behavior (the pin is modern-di>=3,<4)
  • "The user owns the root container fixture" -> "You provide the root container fixture"
  • Remove em dashes in the intro and API section (pyproject description untouched)
  • Shared footer: "with an IoC container"; org link sentence without a dash

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

- Apply the override in a fixture so generated fixtures resolve against it
- Replace version note on validate() with current behavior
- Remove em dashes; fix shared footer wording
@lesnik512
lesnik512 merged commit 758c7cd into main Oct 3, 2026
14 checks passed
@lesnik512
lesnik512 deleted the docs/fix-facts branch October 3, 2026 09:54
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