Ticket #10952: docs_auth.txt.patch

docs/topics/auth.txt

@@ -835 +835 @@
           default to :file:`registration/password_change_done.html` if not
           supplied.
 
-.. function:: views.password_reset
+.. function:: views.password_reset(request[, is_admin_site, template_name, email_template_name, password_reset_form, token_generator, post_reset_redirect)
 
-    Allows a user to reset their password, and sends them the new password
-    in an e-mail.
+    Generates a one-use only link for resetting the password and sends it
+    the user in an e-mail.
 
     **Optional arguments:**
 
+        * ``is_admin_site``: This will default to ``False``.
         * ``template_name``: The full name of a template to use for
           displaying the password reset form. This will default to
           :file:`registration/password_reset_form.html` if not supplied.
-
         * ``email_template_name``: The full name of a template to use for
           generating the e-mail with the new password. This will default to
           :file:`registration/password_reset_email.html` if not supplied.
+        * ``password_reset_form``: Form that will be used to generate and
+          send the one-use only link. This will default to ``PasswordResetForm``.
+        * ``token_generator``: Instance of the class to check the password. This
+          will default to ``default_token_generator``, which is an instance of
+          :class:`~django.contrib.auth.tokens.PasswordResetTokenGenerator`.
+        * ``post_reset_redirect``: URL to redirect to after the password reset
+          done. This will default to ``None``.
 
     **Template context:**
 
         * ``form``: The form for resetting the user's password.
 
-.. function:: views.password_reset_done
+.. function:: views.password_reset_done(request[, template_name])
 
     The page shown after a user has reset their password.
 
@@ -864 +871 @@
           default to :file:`registration/password_reset_done.html` if not
           supplied.
 
-.. function:: views.redirect_to_login
+.. function:: views.redirect_to_login(next[, login_url, redirect_field_name])
 
     Redirects to the login page, and then back to another URL after a
     successful login.
@@ -877 +884 @@
 
         * ``login_url``: The URL of the login page to redirect to. This will
           default to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
+        * ``redirect_field_name``: The name of the URL parameter that is used
+          to pass the URL to redirect to. This will default to the value of
+          :data:`django.contrib.auth.REDIRECT_FIELD_NAME`.
 
 .. function:: password_reset_confirm(request[,uidb36, token, template_name, token_generator, set_password_form, post_reset_redirect])
 
@@ -886 +896 @@
 
         * ``uidb36``: The user's id encoded in base 36. This will default to
           ``None``.
-        * ``token``: Token to check that the password is valid. This will default to ``None``.
+        * ``token``: Token to check that the password is valid. This will
+          default to ``None``.
         * ``template_name``: The full name of a template to display the confirm
-          password view. Default value is :file:`registration/password_reset_confirm.html`.
-        * ``token_generator``: Instance of the class to check the password. This
-          will default to ``default_token_generator``, it's an instance of
+          view. Default value is :file:`registration/password_reset_confirm.html`.
+        * ``token_generator``: Instance of the class to check the password.
+          This will default to ``default_token_generator``, it's an instance of
           ``django.contrib.auth.tokens.PasswordResetTokenGenerator``.
-        * ``set_password_form``: Form that will use to set the password. This will 
-          default to ``SetPasswordForm``.
-        * ``post_reset_redirect``: URL to redirect after the password reset
+        * ``set_password_form``: Form that will be used to set the password.
+          This will default to ``SetPasswordForm``.
+        * ``post_reset_redirect``: URL to redirect to after the password reset
           done. This will default to ``None``.
 
 .. function:: password_reset_complete(request[,template_name])
 
-   Presents a view that informs that the password has been changed very well.
+   Presents a view that informs that the password reset has been completed.
 
    **Optional arguments:** 
 
@@ -929 +940 @@
 
 .. class:: PasswordResetForm
 
-    A form for resetting a user's password and e-mailing the new password to
-    them.
+    A form for generating and e-mailing a one-use only link to reset a user's
+    password.
 
 .. class:: UserCreationForm