summaryrefslogtreecommitdiff
path: root/docs/userguide.rst
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2017-12-19 23:09:17 +0200
committerAlex Grönholm <alex.gronholm@nextday.fi>2017-12-19 23:10:52 +0200
commit79629ad79640fc52ce9a35851978ca5d812a353d (patch)
tree62c5374b5cd8338c159173e3cf1b59dd9ac0dc6a /docs/userguide.rst
parent5e56860088bab438b0cf234a920d276359f897fd (diff)
downloadapscheduler-79629ad79640fc52ce9a35851978ca5d812a353d.tar.gz
Added combining triggers (AndTrigger + OrTrigger)
Fixes #119.
Diffstat (limited to 'docs/userguide.rst')
-rw-r--r--docs/userguide.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/userguide.rst b/docs/userguide.rst
index 4c1a546..72399c8 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -96,7 +96,7 @@ enough for most purposes. If your workload involves CPU intensive operations, yo
using :class:`~apscheduler.executors.pool.ProcessPoolExecutor` instead to make use of multiple CPU
cores. You could even use both at once, adding the process pool executor as a secondary executor.
-When you schedule a job, you need to choose a _trigger_ for it. The trigger determines the logic by
+When you schedule a job, you need to choose a *trigger* for it. The trigger determines the logic by
which the dates/times are calculated when the job will be run. APScheduler comes with three
built-in trigger types:
@@ -107,6 +107,10 @@ built-in trigger types:
* :mod:`~apscheduler.triggers.cron`:
use when you want to run the job periodically at certain time(s) of day
+It is also possible to combine multiple triggers into one which fires either on times agreed on by
+all the participating triggers, or when any of the triggers would fire. For more information, see
+the documentation for :mod:`combining triggers <apscheduler.triggers.combining>`.
+
You can find the plugin names of each job store, executor and trigger type on their respective API
documentation pages.