Skip to content

Commit fef641d

Browse files
committed
Clarify some of the password reset docs
Some of the wording was copied from the change password section. Updated the text to clarify that the we are talking about password resets.
1 parent 7089638 commit fef641d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/topics/auth.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1170,24 +1170,25 @@ includes a few other useful built-in views located in
11701170
:file:`registration/password_reset_form.html` if not supplied.
11711171

11721172
* ``email_template_name``: The full name of a template to use for
1173-
generating the email with the new password. Defaults to
1173+
generating the email with the reset password link. Defaults to
11741174
:file:`registration/password_reset_email.html` if not supplied.
11751175

11761176
* ``subject_template_name``: The full name of a template to use for
1177-
the subject of the email with the new password. Defaults
1177+
the subject of the email with the reset password link. Defaults
11781178
to :file:`registration/password_reset_subject.txt` if not supplied.
11791179

11801180
.. versionadded:: 1.4
11811181

1182-
* ``password_reset_form``: Form that will be used to set the password.
1183-
Defaults to :class:`~django.contrib.auth.forms.PasswordResetForm`.
1182+
* ``password_reset_form``: Form that will be used to get the email of
1183+
the user to reset the password for. Defaults to
1184+
:class:`~django.contrib.auth.forms.PasswordResetForm`.
11841185

1185-
* ``token_generator``: Instance of the class to check the password. This
1186-
will default to ``default_token_generator``, it's an instance of
1186+
* ``token_generator``: Instance of the class to check the one time link.
1187+
This will default to ``default_token_generator``, it's an instance of
11871188
``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
11881189

11891190
* ``post_reset_redirect``: The URL to redirect to after a successful
1190-
password change.
1191+
password reset request.
11911192

11921193
* ``from_email``: A valid email address. By default Django uses
11931194
the :setting:`DEFAULT_FROM_EMAIL`.
@@ -1218,7 +1219,7 @@ includes a few other useful built-in views located in
12181219

12191220
* ``uid``: The user's id encoded in base 36.
12201221

1221-
* ``token``: Token to check that the password is valid.
1222+
* ``token``: Token to check that the reset link is valid.
12221223

12231224
Sample ``registration/password_reset_email.html`` (email body template):
12241225

0 commit comments

Comments
 (0)