summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsujayskumar <sujay.skumar141295@gmail.com>2015-06-18 18:19:35 +0530
committerTim Graham <timograham@gmail.com>2015-09-18 18:56:04 -0400
commitd8d853378b3ff75c03d8bd91ea026d2b8c642b0f (patch)
tree2940f0b5eff6cef6848da60ad7c22acf63f43447 /docs
parentaac2a2d2ae2486342058db0c72ed7ba2c7c8eb1e (diff)
Fixed #24944 -- Added extra_email_context parameter to password_reset() view.
Diffstat (limited to 'docs')
-rw-r--r--docs/releases/1.9.txt3
-rw-r--r--docs/topics/auth/default.txt9
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/releases/1.9.txt b/docs/releases/1.9.txt
index 411d8bc255..c2079f27d0 100644
--- a/docs/releases/1.9.txt
+++ b/docs/releases/1.9.txt
@@ -209,6 +209,9 @@ Minor features
makes it possible to use ``REMOTE_USER`` for setups where the header is only
populated on login pages instead of every request in the session.
+* The :func:`~django.contrib.auth.views.password_reset` view accepts an
+ ``extra_email_context`` parameter.
+
:mod:`django.contrib.contenttypes`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index e0bbb6eb64..8da0e78c47 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -1219,7 +1219,7 @@ implementation details see :ref:`using-the-views`.
The ``current_app`` parameter is deprecated and will be removed in
Django 2.0. Callers should set ``request.current_app`` instead.
-.. function:: password_reset(request, is_admin_site=False, template_name='registration/password_reset_form.html', email_template_name='registration/password_reset_email.html', subject_template_name='registration/password_reset_subject.txt', password_reset_form=PasswordResetForm, token_generator=default_token_generator, post_reset_redirect=None, from_email=None, current_app=None, extra_context=None, html_email_template_name=None)
+.. function:: password_reset(request, is_admin_site=False, template_name='registration/password_reset_form.html', email_template_name='registration/password_reset_email.html', subject_template_name='registration/password_reset_subject.txt', password_reset_form=PasswordResetForm, token_generator=default_token_generator, post_reset_redirect=None, from_email=None, current_app=None, extra_context=None, html_email_template_name=None, extra_email_context=None)
Allows a user to reset their password by generating a one-time use link
that can be used to reset the password, and sending that link to the
@@ -1280,6 +1280,9 @@ implementation details see :ref:`using-the-views`.
for generating a ``text/html`` multipart email with the password reset
link. By default, HTML email is not sent.
+ * ``extra_email_context``: A dictionary of context data that will available
+ in the email template.
+
.. deprecated:: 1.8
The ``is_admin_site`` argument is deprecated and will be removed in
@@ -1290,6 +1293,10 @@ implementation details see :ref:`using-the-views`.
The ``current_app`` parameter is deprecated and will be removed in
Django 2.0. Callers should set ``request.current_app`` instead.
+ .. versionadded:: 1.9
+
+ The ``extra_email_context`` parameter was added.
+
**Template context:**
* ``form``: The form (see ``password_reset_form`` above) for resetting