[Django] #34154: Inconsistent use of "mixin" in the documentation

0 views
Skip to first unread message

Django

unread,
Nov 12, 2022, 2:31:42 PM11/12/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
--------------------------------------------+------------------------
Reporter: Willem Van Onsem | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 4.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 |
--------------------------------------------+------------------------
In the documentation on authentication, we see:

> The `LoginRequired` mixin

and further we see:

> The `PermissionRequiredMixin` mixin

In the first, it does not include the `Mixin` suffix, whereas in the
latter, it does. I think it is better to use the latter, since that refers
to the real name of the mixin, and furthermore the
[https://en.wikipedia.org/wiki/RAS_syndrome RAS syndrome] is usually
allowed repeating `Mixin` twice.

Another option could be to format it with:

> The `LoginRequiredMixin`.

--
Ticket URL: <https://code.djangoproject.com/ticket/34154>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Nov 12, 2022, 5:07:05 PM11/12/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
----------------------------------+----------------------------------------
Reporter: Willem Van Onsem | Owner: Tony Lechner
Type: Uncategorized | Status: assigned
Component: Documentation | Version: 4.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 Tony Lechner):

* owner: nobody => Tony Lechner
* status: new => assigned
* stage: Unreviewed => Accepted


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

Django

unread,
Nov 12, 2022, 5:24:19 PM11/12/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
----------------------------------+----------------------------------------
Reporter: Willem Van Onsem | Owner: Tony Lechner
Type: Uncategorized | Status: assigned
Component: Documentation | Version: 4.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 Tony Lechner):

* has_patch: 0 => 1


Comment:

[https://github.com/django/django/pull/16295 PR].

I don't see any other violations of this pattern on cursory greps through
the doc tree.

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

Django

unread,
Nov 13, 2022, 1:12:47 PM11/13/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
-------------------------------------+-------------------------------------

Reporter: Willem Van Onsem | Owner: Tony
Type: | Lechner
Cleanup/optimization | Status: assigned

Component: Documentation | Version: 4.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 Tony Lechner):

* type: Uncategorized => Cleanup/optimization


--
Ticket URL: <https://code.djangoproject.com/ticket/34154#comment:3>

Django

unread,
Nov 13, 2022, 11:29:13 PM11/13/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
-------------------------------------+-------------------------------------
Reporter: Willem Van Onsem | Owner: Tony
Type: | Lechner
Cleanup/optimization | Status: closed
Component: Documentation | Version: 4.1
Severity: Normal | Resolution: fixed

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 GitHub <noreply@…>):

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


Comment:

In [changeset:"b088cc2feaac638aea91e4d3ab22d276f81630ff" b088cc2]:
{{{
#!CommitTicketReference repository=""
revision="b088cc2feaac638aea91e4d3ab22d276f81630ff"
Fixed #34154 -- Made mixin headers consistent in auth docs.
}}}

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

Django

unread,
Nov 13, 2022, 11:29:47 PM11/13/22
to django-...@googlegroups.com
#34154: Inconsistent use of "mixin" in the documentation
-------------------------------------+-------------------------------------
Reporter: Willem Van Onsem | Owner: Tony
Type: | Lechner
Cleanup/optimization | Status: closed
Component: Documentation | Version: 4.1
Severity: Normal | Resolution: fixed
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 Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"939bab68d80f6b1252842d332e8cbe7ab46ad360" 939bab6]:
{{{
#!CommitTicketReference repository=""
revision="939bab68d80f6b1252842d332e8cbe7ab46ad360"
[4.1.x] Fixed #34154 -- Made mixin headers consistent in auth docs.

Backport of b088cc2feaac638aea91e4d3ab22d276f81630ff from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/34154#comment:5>

Reply all
Reply to author
Forward
0 new messages