Improved docs on background jobs on instances #20489
Open
Conversation
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
jeremystretch
requested review from
a team and
arthanson
and removed request for
a team
arthanson
requested changes
Oct 7, 2025
There was a problem hiding this comment.
@991jo can you please provide an example for this, also lower in the file under Scheduled Jobs the example there does enqueue with instance=self and not derived from JobsMixin which either the example is wrong or the wording here is not clear - can you please take a look.
Also, here is a bit reworded description that might be a bit clearer?
A Job can be executed for a specific instance of a Model. To enable this functionality, the model must include the JobsMixin.
When enqueuing a Job, you can associate it with a particular instance by passing that instance to the instance parameter.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes: #20488