Docstring for on_retry

Author: humitos

readthedocs/projects/tasks/builds.py

@@ -471,6 +471,15 @@ def on_success(self, retval, task_id, args, kwargs):
         self.data.build['success'] = True
 
     def on_retry(self, exc, task_id, args, kwargs, einfo):
+        """
+        Celery helper called when the task is retried.
+
+        This happens when any of the exceptions defined in ``autoretry_for``
+        argument is raised or when ``self.retry`` is called from inside the
+        task.
+
+        See https://docs.celeryproject.org/en/master/userguide/tasks.html#retrying
+        """
         log.info('Retrying this task.')
 
         if isinstance(exc, BuildMaxConcurrencyError):