summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHasan Ramezani <hasan.r67@gmail.com>2020-02-17 16:24:34 +0100
committerCarlton Gibson <carlton.gibson@noumenal.es>2020-02-19 15:46:45 +0100
commita73489f162003472708887fac9b98987af6464fd (patch)
treeb59320a289fb96179cbae62613763ae839d0b3b6
parent611d1c114835310a0cd963e20f3e9782c34db847 (diff)
[3.0.x] Fixed #30040 -- Used default permission name in docs examples to avoid confusion.
Backport of b7795d7673f51daf288ac80616ef69b05918ca6b from master
-rw-r--r--docs/topics/auth/default.txt22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index 9f38fb70e4..e593f37e49 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -727,13 +727,13 @@ The ``permission_required`` decorator
from django.contrib.auth.decorators import permission_required
- @permission_required('polls.can_vote')
+ @permission_required('polls.add_choice')
def my_view(request):
...
Just like the :meth:`~django.contrib.auth.models.User.has_perm` method,
permission names take the form ``"<app label>.<permission codename>"``
- (i.e. ``polls.can_vote`` for a permission on a model in the ``polls``
+ (i.e. ``polls.add_choice`` for a permission on a model in the ``polls``
application).
The decorator may also take an iterable of permissions, in which case the
@@ -744,7 +744,7 @@ The ``permission_required`` decorator
from django.contrib.auth.decorators import permission_required
- @permission_required('polls.can_vote', login_url='/loginpage/')
+ @permission_required('polls.add_choice', login_url='/loginpage/')
def my_view(request):
...
@@ -763,7 +763,7 @@ The ``permission_required`` decorator
from django.contrib.auth.decorators import login_required, permission_required
@login_required
- @permission_required('polls.can_vote', raise_exception=True)
+ @permission_required('polls.add_choice', raise_exception=True)
def my_view(request):
...
@@ -789,9 +789,9 @@ To apply permission checks to :doc:`class-based views
from django.contrib.auth.mixins import PermissionRequiredMixin
class MyView(PermissionRequiredMixin, View):
- permission_required = 'polls.can_vote'
+ permission_required = 'polls.add_choice'
# Or multiple of permissions:
- permission_required = ('polls.can_open', 'polls.can_edit')
+ permission_required = ('polls.view_choice', 'polls.change_choice')
You can set any of the parameters of
:class:`~django.contrib.auth.mixins.AccessMixin` to customize the handling
@@ -1621,9 +1621,9 @@ the logged-in user has any permissions in the ``foo`` app::
Evaluating a two-level-attribute lookup as a boolean is a proxy to
:meth:`User.has_perm() <django.contrib.auth.models.User.has_perm>`. For example,
-to check if the logged-in user has the permission ``foo.can_vote``::
+to check if the logged-in user has the permission ``foo.add_vote``::
- {% if perms.foo.can_vote %}
+ {% if perms.foo.add_vote %}
Here's a more complete example of checking permissions in a template:
@@ -1631,10 +1631,10 @@ Here's a more complete example of checking permissions in a template:
{% if perms.foo %}
<p>You have permission to do something in the foo app.</p>
- {% if perms.foo.can_vote %}
+ {% if perms.foo.add_vote %}
<p>You can vote!</p>
{% endif %}
- {% if perms.foo.can_drive %}
+ {% if perms.foo.add_driving %}
<p>You can drive!</p>
{% endif %}
{% else %}
@@ -1647,7 +1647,7 @@ For example:
.. code-block:: html+django
{% if 'foo' in perms %}
- {% if 'foo.can_vote' in perms %}
+ {% if 'foo.add_vote' in perms %}
<p>In lookup works, too.</p>
{% endif %}
{% endif %}