summaryrefslogtreecommitdiff
path: root/docs/extending.rst
diff options
context:
space:
mode:
authoragronholm <devnull@localhost>2011-04-13 05:13:28 +0300
committeragronholm <devnull@localhost>2011-04-13 05:13:28 +0300
commit39c28fa51c8821b0977a71108aec92c2b9df4105 (patch)
tree9642d64cdfc2a233c22f8ac024f2a90356b652f5 /docs/extending.rst
parent3cde39fdb7bfba0cd59ef7004953ad6b9d152009 (diff)
downloadapscheduler-39c28fa51c8821b0977a71108aec92c2b9df4105.tar.gz
Minor documentation fixes
Diffstat (limited to 'docs/extending.rst')
-rw-r--r--docs/extending.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/extending.rst b/docs/extending.rst
index 1030dae..c7ee45c 100644
--- a/docs/extending.rst
+++ b/docs/extending.rst
@@ -8,6 +8,14 @@ APScheduler, such as custom triggers or job stores.
Writing and using custom triggers
---------------------------------
+Triggers determine the times when the jobs should be run.
+APScheduler comes with three built-in triggers --
+:class:`~apscheduler.triggers.simple.SimpleTrigger`,
+:class:`~apscheduler.triggers.interval.IntervalTrigger` and
+:class:`~apscheduler.triggers.cron.CronTrigger`. You don't normally use these
+directly, since the scheduler has shortcut methods for these built-in
+triggers.
+
If you need to use some specialized scheduling algorithm, you can implement
that as a custom trigger class. The only method a trigger class has to
implement is ``get_next_fire_time``. This method receives a starting date