Explain correct `authenticate` usage with custom user model.
|Reported by:||Tom Christie||Owned by:||nobody|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
If using a custom user model, with eg
then it is non-obvious if the correct usage is
authenticate(username=..., password=...) or
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 4 years ago by
|Patch needs improvement:||unset|
comment:4 Changed 4 years ago by
|Severity:||Normal → Release blocker|
|Triage Stage:||Unreviewed → Accepted|