diff options
| author | agronholm <devnull@localhost> | 2011-04-13 05:13:28 +0300 |
|---|---|---|
| committer | agronholm <devnull@localhost> | 2011-04-13 05:13:28 +0300 |
| commit | 39c28fa51c8821b0977a71108aec92c2b9df4105 (patch) | |
| tree | 9642d64cdfc2a233c22f8ac024f2a90356b652f5 /docs | |
| parent | 3cde39fdb7bfba0cd59ef7004953ad6b9d152009 (diff) | |
| download | apscheduler-39c28fa51c8821b0977a71108aec92c2b9df4105.tar.gz | |
Minor documentation fixes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/extending.rst | 8 | ||||
| -rw-r--r-- | docs/index.rst | 14 |
2 files changed, 9 insertions, 13 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 diff --git a/docs/index.rst b/docs/index.rst index 7085ba0..aa225e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -182,7 +182,7 @@ jobstores.X.Y Constructor option Y of jobstore X Job stores ---------- -APScheduler keeps all the scheduled jobs in `job stores`. Job stores are +APScheduler keeps all the scheduled jobs in *job stores*. Job stores are configurable adapters to some back-end that may or may not support persisting job configurations on disk, database or something else. Job stores are added to the scheduler and identified by their aliases. The alias "default" is special @@ -237,18 +237,6 @@ stores**. The job store will raise an exception if you attempt to schedule a noncompliant callable. -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, as discussed in the next section. - - Limiting the number of concurrently executing instances of a job ---------------------------------------------------------------- |