Browse Source

Clarify behavior of rate limits in docs

Jonas Haag 11 years ago
parent
commit
ddeb280436
1 changed files with 8 additions and 4 deletions
  1. 8 4
      docs/userguide/tasks.rst

+ 8 - 4
docs/userguide/tasks.rst

@@ -514,10 +514,14 @@ General
     If it is an integer or float, it is interpreted as "tasks per second".
     If it is an integer or float, it is interpreted as "tasks per second".
 
 
     The rate limits can be specified in seconds, minutes or hours
     The rate limits can be specified in seconds, minutes or hours
-    by appending `"/s"`, `"/m"` or `"/h"` to the value.
-    Example: `"100/m"` (hundred tasks a minute).  Default is the
-    :setting:`CELERY_DEFAULT_RATE_LIMIT` setting, which if not specified means
-    rate limiting for tasks is disabled by default.
+    by appending `"/s"`, `"/m"` or `"/h"` to the value.  Tasks will be evenly
+    distributed over the specified time frame.
+
+    Example: `"100/m"` (hundred tasks a minute). This will enforce a minimum
+    delay of 10ms between starting two tasks.
+    
+    Default is the :setting:`CELERY_DEFAULT_RATE_LIMIT` setting,
+    which if not specified means rate limiting for tasks is disabled by default.
 
 
 .. attribute:: Task.time_limit
 .. attribute:: Task.time_limit