Skip to content

Commit

Permalink
Added a note on how to get job results later
Browse files Browse the repository at this point in the history
Closes #681.
  • Loading branch information
agronholm committed Nov 26, 2023
1 parent 0103577 commit bdf5283
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,12 @@ In some cases, you want to run tasks directly, without involving schedules:
* You're interested in the job's return value

To queue a job and wait for its completion and get the result, the easiest way is to
use :meth:`~Scheduler.run_job`. If you prefer to just launch
a job and not wait for its result, use
:meth:`~Scheduler.add_job` instead. If you want to get the
results later, you can then call
:meth:`~Scheduler.get_job_result` with the job ID you got
from :meth:`~Scheduler.add_job`.
use :meth:`~Scheduler.run_job`. If you prefer to just launch a job and not wait for its
result, use:meth:`~Scheduler.add_job` instead. If you want to get the results later, you
need to pass an appropriate ``result_expiration_time`` parameter to
:meth:`~Scheduler.add_job` so that the result is saved. Then, you can call
:meth:`~Scheduler.get_job_result` with the job ID you got from
:meth:`~Scheduler.add_job` to retrieve the result.

Removing schedules
------------------
Expand Down

0 comments on commit bdf5283

Please sign in to comment.