Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#25895 closed Cleanup/optimization (fixed)

Customizing user admin docs shouldn't override name.

Reported by: Justin Abrahms Owned by: nobody
Component: Documentation Version: master
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

https://github.com/django/django/blob/master/docs/topics/auth/customizing.txt#L342

In the above documentation, we're inheriting from UserAdmin while renaming our own class UserAdmin. Instead, we should rename one of the two of those so it is more clear (and generally doesn't throw pylint errors).

Attachments (1)

25895.diff (2.6 KB) - added by Tim Graham 4 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 4 years ago by Claude Paroz

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization
Version: 1.9master

Changed 4 years ago by Tim Graham

Attachment: 25895.diff added

comment:2 Changed 4 years ago by Tim Graham

Has patch: set

I think import UserAdmin as BaseUserAdmin is an okay way to go. Any preferences?

comment:3 Changed 4 years ago by Justin Abrahms

Sounds good to me. +1 on change. :)

comment:4 Changed 4 years ago by Claude Paroz

Triage Stage: AcceptedReady for checkin

In release notes, you can let one of MyUserAdmin / BaseUserAdmin as UserAdmin.

comment:5 Changed 4 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: newclosed

In 166e0490:

Fixed #25895 -- Used a consistent style for UserAdmin overrides.

Thanks Justin Abrahms for the report.

comment:6 Changed 4 years ago by Tim Graham <timograham@…>

In abeb50db:

[1.9.x] Fixed #25895 -- Used a consistent style for UserAdmin overrides.

Thanks Justin Abrahms for the report.

Backport of 166e0490d39f619928ee9c5133cc5cab0ae5c1db from master

comment:7 Changed 4 years ago by Tim Graham <timograham@…>

In cdc354e:

[1.8.x] Fixed #25895 -- Used a consistent style for UserAdmin overrides.

Thanks Justin Abrahms for the report.

Backport of 166e0490d39f619928ee9c5133cc5cab0ae5c1db from master

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