docs: prose pass, string-injection validation fix, refreshed social card - #261
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
Prose pass over README.md and the published docs, plus a fix for a self-contradiction in the string-injection page and a refreshed social card.
Changes
Dashes: 18 em/en dashes in prose replaced with commas, colons, or periods (0 left).
Bold run-in labels: 30 removed (46 to 16). The FastAPI tips list, the Singleton concurrency list, the Resource method bullets, and the factories
.providerbullets became plain sentences; the injection FAQ became one heading per question (this also fixes item 2, which was indented under item 1);**Example:**,**Note:**, and**Setup:**labels became plain lead-ins. The 16 left are all indocs/agents/issue-tracker.md, which is agent configuration (not in nav) and skipped on purpose.Headings: 86 renamed to sentence case or stripped of bold, across docs and migration guides. The anchors other pages link to (
#using-a-custom-router-class,#quick-reference,#named-scopes-with-the-inject-wrapper,#changes-to-naming-of-methods) keep their slugs.Contrasts, filler, and staging: removed "simply", "In essence", "might seem complex at first glance", a restating closer in generator-injection, and
Per default(now "By default"). Also fixed small grammar slips (as following,an StateNotInitializedError,last initialize value,chooses between provider).The FastAPI tip that pointed to the "container connection" docs now links to the multiple-containers page.
String injection: the page said both that
Provide["..."]validates the string immediately and that container and provider names are only checked at call time. Run against this branch:Provide["NoDots"]andProvide["A..b"]raiseValueError: Invalid provider definitionimmediately (format check inStringProviderDefinition.__init__).@injectonProvide["Ghost.p"](unknown container) decorates without error; calling it raisesValueError: Container Ghost not found in scope!.Provide["Known.missing"](unknown provider on a known container) also decorates without error; calling it raisesValueError: Provider missing not found in container Known.Both places now say that only the format is checked up front and the names are checked at call time.
docs/assets/social-card.pngis replaced with the card regenerated from the current description in docs: sync social-card taglines with repo descriptions .github#125 (blob9569337on .github main).Checklist
ruff)mypyandpyrefly)uv build) if packaging or build config changedmkdocs build --strictpasses)description, profile blurb) if this touches packaging