Skip to content

docs: describe FromDI as a taskiq dependency in README - #32

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

The README called FromDI an inert marker and said setup_di builds the per-task REQUEST child.

Evidence:

  • modern_di_taskiq/main.py FromDI(dependency, *, use_cache=True) returns TaskiqDepends(Dependency(...), use_cache=use_cache).
  • setup_di only stores the container, adds taskiq_message_provider, and registers startup/shutdown handlers. The child is built in build_di_container, a sub-dependency of Dependency.__call__.

Changes

  • Usage paragraph and setup_di row: the FromDI dependency builds the child; setup_di registers the message provider.
  • FromDI row: real signature and behavior.
  • Rewrite the unclear async-finalizer sentence plainly; remove dashes.
  • Footer: "with IoC container" -> "with an IoC container", and the org-profile line no longer uses 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

Docs-only change. just lint-ci and just test pass; no mkdocs.yml in this repo.

- FromDI is a TaskiqDepends taking use_cache, not an inert marker
- The per-task REQUEST child is built by the FromDI dependency, not setup_di
- Plain wording for async teardown; drop dashes
- Footer wording fix
@lesnik512
lesnik512 merged commit e200031 into main Oct 3, 2026
14 checks passed
@lesnik512
lesnik512 deleted the docs/fix-facts branch October 3, 2026 09:53
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