Skip to content

docs: rewrite Flask setup paragraph plainly - #34

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

Rewrite the setup paragraph and example comment in plain terms.

Changes

  • The paragraph after the example repeated "no shutdown hook" twice, used bold phrases, and carried version history ("As of modern-di 3.1", "Validation is explicit in 3.1"). Split it into an auto_inject paragraph and a short lifecycle paragraph: the container is open from construction, call .validate() after setup_di (which registers flask_request_provider, modern_di_flask/main.py:39), and call fetch_di_container(app).close_sync() at process shutdown.
  • The example comment talked about auto_inject, which the example does not use, and had an em dash. Removed it; the validate() comment now matches the other integration READMEs.
  • Removed the remaining em dashes in the usage intro and the setup_di API row.
  • Footer: "with IoC container" -> "with an IoC container"; replaced the em dash in the org link line.

Checklist

  • Lint and format pass (ruff)
  • Type check passes (ty)
  • Tests pass and new behavior is covered (docs only, no behavior change)
  • 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

- drop version history and repetition from the lifecycle paragraph
- fix example comment that referenced auto_inject
- drop em dashes
- footer wording
@lesnik512
lesnik512 merged commit f70fbf3 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