Explain correct `authenticate` usage with custom user model.
|Reported by:||tomchristie||Owned by:||nobody|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
If using a custom user model, with eg USERNAME_FIELD='email',
then it is non-obvious if the correct usage is authenticate(username=..., password=...) or authenticate(email=..., password=...)
Bit of an easy stumbling point, and it won't be obvious to the developer why login is failing, so we should really note the usage here.
This was the best phrasing I could come up with, but happy to take other suggestions.
Marking as a bug, because I'd consider this a documentation bug, until resolved.
Change History (13)
comment:1 Changed 3 years ago by tomchristie
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
comment:4 Changed 3 years ago by aaugustin
- Severity changed from Normal to Release blocker
- Triage Stage changed from Unreviewed to Accepted
comment:11 Changed 3 years ago by Preston Holmes <preston@…>
- Resolution set to fixed
- Status changed from new to closed