#21325 closed Bug (fixed)
permission_required documentation is missing required arguement
| Reported by: | anonymous | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 1.5 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
Currently, the permission_required decorator (https://docs.djangoproject.com/en/1.5/topics/auth/default/#django.contrib.auth.decorators.permission_required) does not show the correct number of arguments in the documentation. It is missing the 'perm' required argument. However, the description does mention the require argument.
Documentation: permission_required([login_url=None, raise_exception=False])
Source Code: permission_required(perm, login_url=None, raise_exception=False)
Change History (4)
comment:1 by , 10 years ago
| Easy pickings: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Uncategorized → Bug |
comment:2 by , 10 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
Indeed, the first argument is missing from the signature.
Note that first argument is a permission's name or - in the newest version of django (1.7) - a list of permissions.