Skip to content

docs: use the API table format in README - #70

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 API section used dash bullets while the other integration READMEs use a Symbol/Description table (e.g. modern-di-aiohttp). The context-provider entry lacked its scope.

Evidence:

  • modern_di_faststream/main.py:14: faststream_message_provider is Scope.REQUEST.
  • modern_di_faststream/main.py:108-110: FromDI(dependency, *, use_cache=True, cast=False) (already correct, kept).
  • install_middleware raises RuntimeError when the app has no broker.

Changes

  • Convert the API bullets to the table format.
  • Add (REQUEST scope) to the context provider row; name the RuntimeError and the return value of setup_di.
  • 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.

- Convert API bullets to the table used by the other integrations
- Add REQUEST scope to the context provider row
- Footer wording fix
@lesnik512
lesnik512 merged commit aee67f3 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