Repository navigation
docs: clean up README examples, API table and footer - #62
Merged
Merged
Conversation
- Sort example imports, drop unused FromDI import, use the loop variable - FromDI(provider) -> FromDI(dependency); API section as a table - Rewrite Used by entry; remove dashes; fix shared footer wording
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README fixes from a docs review.
FromDIwithout using it and had an unused loop variable (ruff I001, F401, B007)FromDI(provider), but it accepts a provider or a type (modern_di_typer/main.py:FromDI = integrations.from_di); other integration READMEs call the argumentdependencyChanges
FromDIimport, passjob_nametorun(); both snippets passruff checkandruff format --check(undefined placeholder names aside)Symbol | Descriptiontable used by the other integrations;FromDI(dependency);action_scope(ctx)kept (exported frommodern_di_typer/__init__.py)Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaging