Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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.
  • Loading branch information...
commit fef641d1640c0de3ce816bcc1ab9bbb12002d69a 1 parent 7089638
Chris Streeter authored August 31, 2012

Showing 1 changed file with 9 additions and 8 deletions. Show diff stats Hide diff stats

  1. 17  docs/topics/auth.txt
17  docs/topics/auth.txt
@@ -1170,24 +1170,25 @@ includes a few other useful built-in views located in
1170 1170
       :file:`registration/password_reset_form.html` if not supplied.
1171 1171
 
1172 1172
     * ``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
1174 1174
       :file:`registration/password_reset_email.html` if not supplied.
1175 1175
 
1176 1176
     * ``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
1178 1178
       to :file:`registration/password_reset_subject.txt` if not supplied.
1179 1179
 
1180 1180
       .. versionadded:: 1.4
1181 1181
 
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`.
1184 1185
 
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
1187 1188
       ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
1188 1189
 
1189 1190
     * ``post_reset_redirect``: The URL to redirect to after a successful
1190  
-      password change.
  1191
+      password reset request.
1191 1192
 
1192 1193
     * ``from_email``: A valid email address. By default Django uses
1193 1194
       the :setting:`DEFAULT_FROM_EMAIL`.
@@ -1218,7 +1219,7 @@ includes a few other useful built-in views located in
1218 1219
 
1219 1220
     * ``uid``: The user's id encoded in base 36.
1220 1221
 
1221  
-    * ``token``: Token to check that the password is valid.
  1222
+    * ``token``: Token to check that the reset link is valid.
1222 1223
 
1223 1224
     Sample ``registration/password_reset_email.html`` (email body template):
1224 1225
 

0 notes on commit fef641d

Please sign in to comment.
Something went wrong with that request. Please try again.