From 40ac0bfce507bc5d6880917ca54950e18ffe6998 Mon Sep 17 00:00:00 2001 From: Ilan Date: Thu, 16 Jul 2015 21:01:27 +0200 Subject: [PATCH] Minor updates to `timeout` docs --- docs/install.rst | 4 +++- docs/tasks.rst | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 7f8d4bb..e7e283b 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -65,11 +65,13 @@ recycle The number of tasks a worker will process before recycling . Useful to release memory resources on a regular basis. Defaults to ``500``. +.. _timeout: + 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 project. +Set this to something that makes sense for your project. Can be overridden for individual tasks. compress ~~~~~~~~ diff --git a/docs/tasks.rst b/docs/tasks.rst index 70da421..c3fd630 100644 --- a/docs/tasks.rst +++ b/docs/tasks.rst @@ -87,7 +87,7 @@ Reference :type func: object :param hook: Optional function to call after execution :type hook: object - :param int timeout: timeout in seconds. Overrides the cluster setting. + :param int timeout: Overrides global cluster :ref:`timeout`. :param bool sync: If set to True, async will simulate a task execution :param redis: Optional redis connection :param kwargs: Keyword arguments for the task function