diff options
| author | markotibold | 2011-05-19 19:36:30 +0200 |
|---|---|---|
| committer | markotibold | 2011-05-19 19:36:30 +0200 |
| commit | 82c4ca96126cfedd4a8471452d956e8bb432ba5b (patch) | |
| tree | f92502c69a826b6f0cea24a3054c3e893122dc36 /djangorestframework/permissions.py | |
| parent | e7f8c06dbbbc9e4ae91327ee02cd8147777b17e2 (diff) | |
| download | django-rest-framework-82c4ca96126cfedd4a8471452d956e8bb432ba5b.tar.bz2 | |
The core is now documented from the docstrings in the source.
Diffstat (limited to 'djangorestframework/permissions.py')
| -rw-r--r-- | djangorestframework/permissions.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/djangorestframework/permissions.py b/djangorestframework/permissions.py index 3831424f..1f6151f8 100644 --- a/djangorestframework/permissions.py +++ b/djangorestframework/permissions.py @@ -1,3 +1,9 @@ +""" +The :mod:`permissions` module bundles a set of permission classes that are used +for checking if a request passes a certain set of constraints. You can assign a permision +class to your view by setting your View's :attr:`permissions` class attribute. +""" + from django.core.cache import cache from djangorestframework import status from djangorestframework.response import ErrorResponse @@ -36,7 +42,7 @@ class BasePermission(object): def check_permission(self, auth): """ - Should simply return, or raise an :class:`response.ErrorResponse`. + Should simply return, or raise an :exc:`response.ErrorResponse`. """ pass |
