Skip to content

Specify the_task.get() value when the_task raises #899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhpyle merged 3 commits into from
Mar 24, 2026
Merged

Specify the_task.get() value when the_task raises #899

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae07032
Specify the_task.get() value when the_task raises
plocket Jan 13, 2026
9e6c7aa
Add missing paren and tweak wording
plocket Jan 28, 2026
056abad
Make sentence less grammatically complex
plocket Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion _docs/background.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,9 @@ called `the_task`. This variable can be used in the following ways:
then return `True`.
* `the_task.get()` returns the result of the task. If the task has
not been completed yet, the system will wait until the task is
completed and then return the result of the task.
completed and then return the result of the task. `the_task.get()`
returns `None` if the task or an action triggered by the task
(including a `background_error_action`) raised an error.
* `the_task.result()` is like `.get()`, except it returns an object
containing details about the result of the task. This is useful
primarily if the task ended prematurely because an exception was
Expand Down