summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-09-28 14:08:17 -0400
committerTim Graham <timograham@gmail.com>2015-09-28 14:11:54 -0400
commitc14b6b52ff131db263bf06a02f903a73390975da (patch)
tree5b0eeed930134a2ba03107e1f8214ac0418c906c
parent17e2edf113f3d1590b66b1c7107ef513eb5a35c3 (diff)
Documented auth's login/logout function parameters.
-rw-r--r--docs/topics/auth/default.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index 9ae5a50cd5..15098f6517 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -322,7 +322,7 @@ How to log a user in
If you have an authenticated user you want to attach to the current session
- this is done with a :func:`~django.contrib.auth.login` function.
-.. function:: login()
+.. function:: login(request, user)
To log a user in, from a view, use :func:`~django.contrib.auth.login()`. It
takes an :class:`~django.http.HttpRequest` object and a
@@ -370,7 +370,7 @@ If you have an authenticated user you want to attach to the current session
How to log a user out
---------------------
-.. function:: logout()
+.. function:: logout(request)
To log out a user who has been logged in via
:func:`django.contrib.auth.login()`, use