Browse files

[1.2.X] Fixed #13503 -- Corrected misleading custom permission exampl…

…e in the docs.

Thanks Daniel Moisset for the report.

Backport of [14403] from trunk

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 29ea1be commit 20c6f3f3d1a58960fcc141eb461f244ebdf266d0 @ramiro ramiro committed Oct 31, 2010
Showing with 11 additions and 7 deletions.
  1. +11 −7 docs/topics/auth.txt
@@ -1181,19 +1181,23 @@ Custom permissions
To create custom permissions for a given model object, use the ``permissions``
:ref:`model Meta attribute <meta-options>`.
-This example model creates three custom permissions::
+This example Task model creates three custom permissions, i.e., actions users
+can or cannot do with Task instances, specific to your appication::
- class USCitizen(models.Model):
- # ...
+ class Task(models.Model):
+ ...
class Meta:
permissions = (
- ("can_drive", "Can drive"),
- ("can_vote", "Can vote in elections"),
- ("can_drink", "Can drink alcohol"),
+ ("can_view", "Can see available tasks"),
+ ("can_change_status", "Can change the status of tasks"),
+ ("can_close", "Can remove a task by setting its status as closed"),
The only thing this does is create those extra permissions when you run
-:djadmin:` syncdb <syncdb>`.
+:djadmin:` syncdb <syncdb>`. Your code is in charge of checking the
+value of these permissions when an user is trying to access the functionality
+provided by the application (viewing tasks, changing the status of tasks,
+closing tasks.)
API reference

0 comments on commit 20c6f3f

Please sign in to comment.