[Django] #35939: Reference documentation for auth.Permission should link to ContentType

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 5.1 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
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
--
Ticket URL: <https://code.djangoproject.com/ticket/35939>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType

--------------------------------------+------------------------------------
Reporter: Baptiste Mispelon | Owner: (none)

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 5.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Simon Charette):

* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:1>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType

-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley
Cleanup/optimization | Status: assigned

Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Brock Smickley):

* owner: (none) => Brock Smickley
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:2>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Brock Smickley):

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
[https://github.com/django/django/blob/857b1048d53ebf5fc5581c110e85c212b81ca83a/docs/ref/contrib/contenttypes.txt#L54
line].
--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:3>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Brock Smickley):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:4>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Brock Smickley):

forgot to link the pr here: https://github.com/django/django/pull/18851
--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:5>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:6>

[Django]

#35939: Reference documentation for auth.Permission should link to ContentType
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Brock
Type: | Smickley

Cleanup/optimization | Status: closed
Component: Documentation | Version: 5.1
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce <42296566+sarahboyce@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"d8eb13f0f88d4462e70af74f4e9c930126e14306" d8eb13f]:
{{{#!CommitTicketReference repository=""
revision="d8eb13f0f88d4462e70af74f4e9c930126e14306"
Fixed #35939 -- Linked documentation of Permission.content_type to the
ContentType model.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35939#comment:7>