From d8b5d6603ed5095d8fa62147196e0c5b1e642325 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 13 Sep 2012 18:35:06 +0100 Subject: [PATCH] Tweak copy --- docs/api-guide/throttling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index acad82cd7..0856183b4 100644 --- a/docs/api-guide/throttling.md +++ b/docs/api-guide/throttling.md @@ -122,7 +122,7 @@ User requests to either `ContactListView` or `ContactDetailView` would be restri ## Custom throttles -To implement a custom throttle, override `BaseThrottle` and implement `.allow_request(request)`. The method should return `True` if the request should be allowed, and `False` otherwise. +To create a custom throttle, override `BaseThrottle` and implement `.allow_request(request)`. The method should return `True` if the request should be allowed, and `False` otherwise. Optionally you may also override the `.wait()` method. If implemented, `.wait()` should return a recomended number of seconds to wait before attempting the next request, or `None`. The `.wait()` method will only be called if `.check_throttle()` has previously returned `False`.