p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #315 from streeter/auth-docs-cleanup-patch 

Clarify some of the password reset docs
This commit is contained in:
Tim Graham 2012-09-01 15:05:18 -07:00
parent 28fd876bae fef641d164
commit 03ad7d3c20
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/topics/auth.txt
View File

@ -1170,24 +1170,25 @@ includes a few other useful built-in views located in
:file:`registration/password_reset_form.html` if not supplied. :file:`registration/password_reset_form.html` if not supplied.
* ``email_template_name``: The full name of a template to use for * ``email_template_name``: The full name of a template to use for
generating the email with the new password. Defaults to generating the email with the reset password link. Defaults to
:file:`registration/password_reset_email.html` if not supplied. :file:`registration/password_reset_email.html` if not supplied.
* ``subject_template_name``: The full name of a template to use for * ``subject_template_name``: The full name of a template to use for
the subject of the email with the new password. Defaults the subject of the email with the reset password link. Defaults
to :file:`registration/password_reset_subject.txt` if not supplied. to :file:`registration/password_reset_subject.txt` if not supplied.
.. versionadded:: 1.4 .. versionadded:: 1.4
* ``password_reset_form``: Form that will be used to set the password. * ``password_reset_form``: Form that will be used to get the email of
Defaults to :class:`~django.contrib.auth.forms.PasswordResetForm`. the user to reset the password for. Defaults to
:class:`~django.contrib.auth.forms.PasswordResetForm`.
* ``token_generator``: Instance of the class to check the password. This * ``token_generator``: Instance of the class to check the one time link.
will default to ``default_token_generator``, it's an instance of This will default to ``default_token_generator``, it's an instance of
``django.contrib.auth.tokens.PasswordResetTokenGenerator``. ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
* ``post_reset_redirect``: The URL to redirect to after a successful * ``post_reset_redirect``: The URL to redirect to after a successful
password change. password reset request.
* ``from_email``: A valid email address. By default Django uses * ``from_email``: A valid email address. By default Django uses
the :setting:`DEFAULT_FROM_EMAIL`. the :setting:`DEFAULT_FROM_EMAIL`.
@ -1218,7 +1219,7 @@ includes a few other useful built-in views located in
* ``uid``: The user's id encoded in base 36. * ``uid``: The user's id encoded in base 36.
* ``token``: Token to check that the password is valid. * ``token``: Token to check that the reset link is valid.
Sample ``registration/password_reset_email.html`` (email body template): Sample ``registration/password_reset_email.html`` (email body template):