docs: minor updates

This commit is contained in:
Ilan
2015-08-19 13:57:46 +02:00
parent 2011efbe0a
commit 9dfb65a7af
2 changed files with 5 additions and 1 deletions
+4
View File
@@ -40,6 +40,8 @@ Here you can check on the status of your scheduled tasks, create, edit or delete
.. image:: _static/scheduled.png
Repeats
~~~~~~~
If you want a schedule to only run a finite amount of times, e.g. every hour for the next 24 hours, you can do that using the :attr:`Schedule.repeats` attribute.
@@ -50,6 +52,8 @@ When you set repeats to ``-1`` the schedule will continue indefinitely and the r
An exception to this are schedules of type :attr:`Schedule.ONCE`. Negative repeats for this schedule type will cause it to be deleted from the database.
This behavior is useful if you have many delayed actions which you do not necessarily need a result for. A positive number will keep the ONCE schedule, but it will not run again.
You can pause a schedule by setting its repeats value to zero.
.. note::
To run a ``ONCE`` schedule again, change the repeats to something other than `0`. Set a new run time before you do this or let it execute immediately.