#34154 closed Cleanup/optimization (fixed)
Inconsistent use of "mixin" in the documentation
| Reported by: | Willem Van Onsem | Owned by: | Tony Lechner |
|---|---|---|---|
| Component: | Documentation | Version: | 4.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
In the documentation on authentication, we see:
The
LoginRequiredmixin
and further we see:
The
PermissionRequiredMixinmixin
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 RAS syndrome is usually allowed repeating Mixin twice.
Another option could be to format it with:
The
LoginRequiredMixin.
Change History (5)
comment:1 by , 2 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 2 years ago
| Has patch: | set |
|---|
comment:3 by , 2 years ago
| Type: | Uncategorized → Cleanup/optimization |
|---|
Note:
See TracTickets
for help on using tickets.
PR.
I don't see any other violations of this pattern on cursory greps through the doc tree.