Browse Source

Docs: Tasks: Clarify that there's no default retry behavior

Ask Solem 8 years ago
parent
commit
7ce913791a
1 changed files with 3 additions and 0 deletions
  1. 3 0
      docs/userguide/tasks.rst

+ 3 - 0
docs/userguide/tasks.rst

@@ -649,6 +649,9 @@ General
 
 .. attribute:: Task.max_retries
 
+    Only applies if the task calls ``self.retry`` or if the task is decorated
+    with the :ref:`autoretry_for <task-autoretry>` argument.
+
     The maximum number of attempted retries before giving up.
     If the number of retries exceeds this value a :exc:`~@MaxRetriesExceededError`
     exception will be raised.  *NOTE:* You have to call :meth:`~@Task.retry`