Opened 2 years ago

Closed 2 years 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 Simon Charette, 2 years ago

Triage Stage: Unreviewed → Accepted

comment:2 by Brock Smickley, 2 years ago

Owner: set to Brock Smickley
Status: new → assigned

comment:3 by Brock Smickley, 2 years ago

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.

comment:4 by Brock Smickley, 2 years ago

Has patch: set

comment:5 by Brock Smickley, 2 years ago

comment:6 by Sarah Boyce, 2 years ago

Triage Stage: Accepted → Ready for checkin

comment:7 by Sarah Boyce <42296566+sarahboyce@…>, 2 years ago

Resolution: → fixed
Status: assigned → closed

In d8eb13f:

Fixed #35939 -- Linked documentation of Permission.content_type to the ContentType model.

Note: See TracTickets for help on using tickets.
Back to Top