From 977cf98ba0e01cf3fae092261b07961cb24410a1 Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Fri, 10 Jul 2015 11:48:15 +0200 Subject: [PATCH] docs: made a note of succesful tasks not showing when the save_limit is set to -1 --- docs/admin.rst | 6 +++++- docs/install.rst | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/admin.rst b/docs/admin.rst index a2f5923..9fc7964 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -16,7 +16,7 @@ Uses the :class:`Success` proxy model. .. tip:: - The maximum number of successful tasks can be set using the `save_limit` :ref:`configuration` option. + The maximum number of successful tasks can be set using the :ref:`save_limit` option. @@ -63,5 +63,9 @@ Success Indicates the success status of the last scheduled task, if any. +.. note:: + + if you have set the :ref:`save_limit` configuration option to not save successful tasks to the database, you will only see the failed results of your schedules. + Uses the :class:`Schedule` model diff --git a/docs/install.rst b/docs/install.rst index caf764b..941685a 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -77,6 +77,8 @@ compress Compresses task packages to Redis. Useful for large payloads, but can add overhead when used with many small packages. Defaults to ``False`` +.. _save_limit: + save_limit ~~~~~~~~~~