docs: correct arq lifecycle description in README - #37
Merged
Merged
Conversation
- List on_job_end as the fourth wired hook (fallback close) - The per-job child opens in on_job_start and the last @Inject call closes it - Split the long usage sentence, drop dashes and bold - Footer wording fix
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
The README usage paragraph said setup_di wires four arq hooks but listed three, and said the per-job child is open only while @Inject bodies run.
Evidence:
modern_di_arq/main.pysetup_disetson_job_endvia_wrap_job_end, which closes the child if it is still open (fallback)._wrap_job_startbuilds the child inon_job_start(open from construction, per thesetup_didocstring);inject's wrapper refcounts and the last call to exit runsclose_async().Changes
on_job_endas the fourth hook and its fallback role.on_job_startand the last@injectcall closes it.Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packagingDocs-only change.
just lint-ciandjust testpass; no mkdocs.yml in this repo.