Fix handlers docs (Issue #9787) #9804
Merged
+116
−32
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
4 tasks
Contributor
Author
|
@auvipy, Can you please review this? |
Member
|
yes |
Contributor
There was a problem hiding this comment.
Pull Request Overview
Clarify task handler execution context, timing, and ordering in the user guide, and provide a concrete example.
- Add a synchronous execution timeline diagram showing handler order and blocking behavior
- Reorganize and expand individual handler method docs with timing notes
- Include a practical code example demonstrating all handlers in action
Comments suppressed due to low confidence (4)
docs/userguide/tasks.rst:1630
- Indent the
.. method::directives consistently (e.g., prefix with two spaces) to match the existingbefore_startstyle and ensure correct Sphinx parsing.
.. method:: on_success(self, retval, task_id, args, kwargs)
docs/userguide/tasks.rst:1648
- Add a note that the return value of
on_retryis ignored, for consistency with the other handler docs (on_successandafter_return).
.. method:: on_retry(self, exc, task_id, args, kwargs, einfo)
docs/userguide/tasks.rst:1666
- Include a sentence stating that the return value of
on_failureis ignored to mirror the pattern inon_successandafter_return.
.. method:: on_failure(self, exc, task_id, args, kwargs, einfo)
docs/userguide/tasks.rst:1596
- [nitpick] Consider updating ‘Outcome-specific handler’ to the plural ‘Outcome-specific handlers’ for clarity, since multiple handlers appear under this step.
│ 4. on_success() OR ← Outcome-specific handler │
auvipy
approved these changes
Jul 7, 2025
Member
|
hey can you check this #10046 ? |
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.
Summary
This PR updates the Task Handlers documentation to address the confusion described in issue #9787. The original documentation lacked clarity about handler execution context, timing, and order, leading to developer uncertainty about when and where these handlers run.
Issue Description
Issue #9787 highlighted that the handler execution documentation was unclear about:
Changes Made
Resolves #9787
Current Docs
Updated Doc