diff options
| author | Tim Graham <timograham@gmail.com> | 2015-09-28 14:08:17 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2015-09-28 14:13:02 -0400 |
| commit | 5172bb9eec1a7fd52e6486a303c3c753988fb0c0 (patch) | |
| tree | c88eed93ebed18cf86a716d137cdd8f1c55ac538 | |
| parent | 8f42934f86c1c6dff9fb24fd6fadb9d72b89d7b6 (diff) | |
| download | django-5172bb9eec1a7fd52e6486a303c3c753988fb0c0.tar.gz | |
[1.7.x] Documented auth's login/logout function parameters.
Backport of c14b6b52ff131db263bf06a02f903a73390975da from master
| -rw-r--r-- | docs/topics/auth/default.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt index 0dcca0f717..41d7118758 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -326,7 +326,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 @@ -374,7 +374,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 |