Doc'd that users with unusable passwords cannot request a password reset. #15346
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
|
Hello @amingilani! Thank you for your contribution 💪 As it's your first contribution be sure to check out the patch review checklist. If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket! If you have any design or process questions then you can ask in the Django forum. Welcome aboard ⛵️! |
|
Hello! I'm bumping this for feedback :) |
nessita
reviewed
Dec 18, 2023
docs/ref/contrib/auth.txt
Outdated
Comment on lines
185
to
189
| .. note:: | ||
| Users marked with an unusable password will not | ||
| able to request a password reset email via | ||
| :class:`~django.contrib.auth.views.PasswordResetView`. |
There was a problem hiding this comment.
We try to avoid having bare notes in the docs, we prefer admonitions with meaningful titles. For example:
Suggested change
| .. note:: | |
| Users marked with an unusable password will not | |
| able to request a password reset email via | |
| :class:`~django.contrib.auth.views.PasswordResetView`. | |
| .. admonition:: Password reset restriction | |
| Users having an unusable password will not able to request a | |
| password reset email via | |
| :class:`~django.contrib.auth.views.PasswordResetView`. |
There was a problem hiding this comment.
Thank you! I've incorporated your suggestion in my patch :)
amingilani
force-pushed
the
fix-unusable-password-docs
branch
from
c36303e
to
095aa78
Compare
Users having an unusable passwords will not be able to request password reset emails. This important information is only found in the PasswordResetView docs, and not in the set_unusable_password docs. This patch rectifies this shortcoming and places the information where it is needed.
amingilani
force-pushed
the
fix-unusable-password-docs
branch
from
095aa78
to
ab55db0
Compare
nessita
changed the title
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.
Include warning around unusable passwords Users having an unusable passwords will not be able to request password reset emails. This important information is only found in the PasswordResetView docs, and not in the set_unusable_password docs. This patch rectifies this shortcoming and places the information where it is needed.