diff options
| author | Tom Christie | 2012-09-13 18:35:06 +0100 | 
|---|---|---|
| committer | Tom Christie | 2012-09-13 18:35:06 +0100 | 
| commit | d8b5d6603ed5095d8fa62147196e0c5b1e642325 (patch) | |
| tree | 3a66db287a6075ffb7744a1dfdf025ab729af238 /docs/api-guide/throttling.md | |
| parent | 6c109ac60f891955df367c61d4d7094039098076 (diff) | |
| download | django-rest-framework-d8b5d6603ed5095d8fa62147196e0c5b1e642325.tar.bz2 | |
Tweak copy
Diffstat (limited to 'docs/api-guide/throttling.md')
| -rw-r--r-- | docs/api-guide/throttling.md | 2 | 
1 files changed, 1 insertions, 1 deletions
| diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index acad82cd..0856183b 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`. | 
