Browse Source

Document default value of Task.max_retries

Ask Solem 12 years ago
parent
commit
dd137f5442
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/userguide/tasks.rst

+ 4 - 0
docs/userguide/tasks.rst

@@ -390,6 +390,10 @@ General
     exception will be raised.  *NOTE:* You have to call :meth:`~@Task.retry`
     manually, as it will not automatically retry on exception..
 
+    The default value is 3.
+    A value of :const:`None` will disable the retry limit and the
+    task will retry forever until it succeeds.
+
 .. attribute:: Task.default_retry_delay
 
     Default time in seconds before a retry of the task