From ef075b7e033447aee88e8ed311024488184d17b5 Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Sat, 4 Jul 2015 18:54:48 +0200 Subject: [PATCH] Small docs changes --- docs/cluster.rst | 5 ++++- docs/install.rst | 17 ++++++++--------- docs/schedules.rst | 2 ++ 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/cluster.rst b/docs/cluster.rst index cba3e90..543d21e 100644 --- a/docs/cluster.rst +++ b/docs/cluster.rst @@ -108,7 +108,10 @@ Meanwhile the the sentinel checks if the timers don't exceed the timeout amount, Scheduler """"""""" Once a minute the scheduler checks for any scheduled task that should be starting. -It creates and queues a new task from the schedule and sets the next run date. + +- Creates a task from the schedule +- Subtracts 1 from the :ref:`repeats` setting +- Sets the next run time if there are repeats left .. _stop_procedure: diff --git a/docs/install.rst b/docs/install.rst index 3dd0436..7cbb443 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -6,7 +6,7 @@ Installation $ pip install django-q -- Add :mod:`django_q` to your :const:`INSTALLED_APPS` in your projects :file:`settings.py`:: +- Add :mod:`django_q` to :const:`INSTALLED_APPS` in your projects :file:`settings.py`:: INSTALLED_APPS = ( # other apps @@ -69,22 +69,22 @@ timeout ~~~~~~~ The number of seconds a worker is allowed to spend on a task before it's terminated. Defaults to ``None``, meaning it will never time out. -Set this to something that makes sense for your use +Set this to something that makes sense for your project. compress ~~~~~~~~ -Compress task packages to Redis. Useful for large payloads, but can add overhead when used with many small packages. +Compresses task packages to Redis. Useful for large payloads, but can add overhead when used with many small packages. Defaults to ``False`` save_limit ~~~~~~~~~~ Limits the amount of successful tasks saved to Django. -Set to ``0`` for unlimited. -Set to ``-1`` for no success storage at all. -Defaults to ``250`` -Failures are always saved. +- Set to ``0`` for unlimited. +- Set to ``-1`` for no success storage at all. +- Defaults to ``250`` +- Failures are always saved. label ~~~~~ @@ -120,7 +120,6 @@ Django Q is tested for Python 2.7 and 3.4 - `Django `__ - The web framework for perfectionists with deadlines. Django Q aims to use as much of Django's standard offerings as possible The code is tested against Django version `1.7.8` and `1.8.2`. @@ -130,7 +129,7 @@ Django Q is tested for Python 2.7 and 3.4 - `Redis-py `__ - Redis python client. + Andy McCurdy's excellent Redis python client. - `Arrow `__ diff --git a/docs/schedules.rst b/docs/schedules.rst index f67197a..7f1ca72 100644 --- a/docs/schedules.rst +++ b/docs/schedules.rst @@ -63,6 +63,8 @@ Schedules are regular Django models. You can manage them through the :ref:`admin `ONCE`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`. `QUARTERLY`, `YEARLY` + .. _repeats: + .. py:attribute:: repeats Number of times to repeat the schedule. -1=Always, 0=Never, n =n.