Note authenticate usage with custom user model.
#669
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, so we should really note the usage here.
|
Corresponding trac ticket 19662 |
|
👍 to the change 👎 to the yuk |
|
I'm going to close this PR because it doesn't reflect the latest comments on the ticket and the patch is fairly trivial anyway (unless we decide to change the behavior). |
ramiro
pushed a commit
to ramiro/django
that referenced
this pull request
Jul 2, 2017
StrictVersion.__cmp__() raises an exception comparing to 'dev'.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If using a custom user model, with eg
USERNAME_FIELD='email',then it is non-obvious if the correct usage is
authenticate(username=..., password=...)orauthenticate(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.