diff options
| author | Russell Keith-Magee <russell@keith-magee.com> | 2009-09-13 01:13:40 +0000 |
|---|---|---|
| committer | Russell Keith-Magee <russell@keith-magee.com> | 2009-09-13 01:13:40 +0000 |
| commit | 0e07f80cf4cf05bbb14fa18cc0013f3cd66687f8 (patch) | |
| tree | 2612ce3be5daf36280222161a7930dea3241f362 /docs/topics/auth.txt | |
| parent | d0c6e9cf63f2a96d0abe58d392a6085f4da85d7b (diff) | |
Fixed #9414 -- Clarified the documentation on the permission decorators. Thanks to timo for the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@11547 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/topics/auth.txt')
| -rw-r--r-- | docs/topics/auth.txt | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/topics/auth.txt b/docs/topics/auth.txt index 40243cca8c..6a62be8c32 100644 --- a/docs/topics/auth.txt +++ b/docs/topics/auth.txt @@ -212,14 +212,15 @@ Methods .. method:: models.User.has_perm(perm) Returns ``True`` if the user has the specified permission, where perm is - in the format ``"<application name>.<lowercased model name>"``. If the - user is inactive, this method will always return ``False``. + in the format ``"<app label>.<permission codename>"``. + If the user is inactive, this method will always return ``False``. .. method:: models.User.has_perms(perm_list) Returns ``True`` if the user has each of the specified permissions, - where each perm is in the format ``"package.codename"``. If the user is - inactive, this method will always return ``False``. + where each perm is in the format + ``"<app label>.<permission codename>"``. If the user is inactive, + this method will always return ``False``. .. method:: models.User.has_module_perms(package_name) @@ -1062,8 +1063,8 @@ The permission_required decorator my_view = permission_required('polls.can_vote')(my_view) As for the :meth:`User.has_perm` method, permission names take the form - ``"<application name>.<lowercased model name>"`` (i.e. ``polls.choice`` for - a ``Choice`` model in the ``polls`` application). + ``"<app label>.<permission codename>"`` (i.e. ``polls.can_vote`` for a + permission on a model in the ``polls`` application). Note that :func:`~django.contrib.auth.decorators.permission_required()` also takes an optional ``login_url`` parameter. Example:: |
