feat(dev): Add docs for UserFacingProcessingException #13885
Merged
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
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
kyteinsky
reviewed
Nov 24, 2025
|
|
||
| .. versionadded:: 33.0.0 | ||
|
|
||
| * ``getUserFacingErrorMessage()`` This returns any error message that is meant to be displayed to the user, even if a task has failed, this is not guaranteed to be set. |
Contributor
There was a problem hiding this comment.
maybe it can be clarified here what is returned when it's not set
Member
Author
There was a problem hiding this comment.
We also don't do that for the other methods 🤔
Contributor
There was a problem hiding this comment.
it might be better to do for all of them but the function signatures/docs can be seen in the IDE too
rakekniven
approved these changes
Nov 24, 2025
kyteinsky
approved these changes
Nov 24, 2025
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.
☑️ Resolves
🖼️ Screenshots