Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.3.X] Fixed #6581 -- Moved documentation of django.contrib.auth.vie…

…ws.redirect_to_login to an own "Helper functions" section.

Backport form trunk (r16130).

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.3.X@16131 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit b44757ce5187fd7019593b838adfd81dfd401b1d 1 parent c05dd20
Jannis Leidel authored

Showing 1 changed file with 23 additions and 19 deletions. Show diff stats Hide diff stats

  1. 42  docs/topics/auth.txt
42  docs/topics/auth.txt
@@ -990,25 +990,6 @@ includes a few other useful built-in views located in
990 990
           default to :file:`registration/password_reset_done.html` if not
991 991
           supplied.
992 992
 
993  
-.. function:: redirect_to_login(next[, login_url, redirect_field_name])
994  
-
995  
-    Redirects to the login page, and then back to another URL after a
996  
-    successful login.
997  
-
998  
-    **Required arguments:**
999  
-
1000  
-        * ``next``: The URL to redirect to after a successful login.
1001  
-
1002  
-    **Optional arguments:**
1003  
-
1004  
-        * ``login_url``: The URL of the login page to redirect to. This will
1005  
-          default to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
1006  
-
1007  
-        * ``redirect_field_name``: The name of a ``GET`` field containing the
1008  
-          URL to redirect to after log out. Overrides ``next`` if the given
1009  
-          ``GET`` parameter is passed.
1010  
-
1011  
-
1012 993
 .. function:: password_reset_confirm(request[, uidb36, token, template_name, token_generator, set_password_form, post_reset_redirect])
1013 994
 
1014 995
     Presents a form for entering a new password.
@@ -1038,6 +1019,29 @@ includes a few other useful built-in views located in
1038 1019
        * ``template_name``: The full name of a template to display the view.
1039 1020
          This will default to :file:`registration/password_reset_complete.html`.
1040 1021
 
  1022
+Helper functions
  1023
+----------------
  1024
+
  1025
+.. module:: django.contrib.auth.views
  1026
+
  1027
+.. function:: redirect_to_login(next[, login_url, redirect_field_name])
  1028
+
  1029
+    Redirects to the login page, and then back to another URL after a
  1030
+    successful login.
  1031
+
  1032
+    **Required arguments:**
  1033
+
  1034
+        * ``next``: The URL to redirect to after a successful login.
  1035
+
  1036
+    **Optional arguments:**
  1037
+
  1038
+        * ``login_url``: The URL of the login page to redirect to. This will
  1039
+          default to :setting:`settings.LOGIN_URL <LOGIN_URL>` if not supplied.
  1040
+
  1041
+        * ``redirect_field_name``: The name of a ``GET`` field containing the
  1042
+          URL to redirect to after log out. Overrides ``next`` if the given
  1043
+          ``GET`` parameter is passed.
  1044
+
1041 1045
 Built-in forms
1042 1046
 --------------
1043 1047
 

0 notes on commit b44757c

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