Opened 6 weeks ago
Closed 6 weeks ago
#35939 closed Cleanup/optimization (fixed)
Reference documentation for auth.Permission should link to ContentType
Reported by: | Baptiste Mispelon | Owned by: | Brock Smickley |
---|---|---|---|
Component: | Documentation | Version: | 5.1 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
The reference documentation for Permission.content_type
[1] [2] describes the field as:
A reference to the django_content_type database table, which contains a record for each installed model.
This seems to me like a more complicated way of saying "A foreign key to the ContentType model". On top of that, it would be useful if either the old wording ("django_content_type table") or the new one ("ContentType model") could link to the reference documentation of the model [3]
[1] https://docs.djangoproject.com/en/dev/ref/contrib/auth/#django.contrib.auth.models.Permission.content_type
[2] https://github.com/django/django/blob/main/docs/ref/contrib/auth.txt#L422
[3] https://docs.djangoproject.com/en/dev/ref/contrib/contenttypes/#the-contenttype-model
Change History (7)
comment:1 by , 6 weeks ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 6 weeks ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:3 by , 6 weeks ago
comment:4 by , 6 weeks ago
Has patch: | set |
---|
comment:6 by , 6 weeks ago
Triage Stage: | Accepted → Ready for checkin |
---|
based on the description in the ticket, it seemed that reporter wanted the description to be linked to the ContentType model header instead of the class, but I couldn't find a clean way to do that. It would probably entail updating this line.