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:12:43 -0400 |
| commit | e6f1b1db4c2f51205a41c95e2053a0faa988e838 (patch) | |
| tree | b8c3719be3555b3e959ac52dce8bfe2282c63fc2 /docs | |
| parent | 5ebf6fd8918f843756a73581bb88f570c4f5d117 (diff) | |
[1.8.x] Documented auth's login/logout function parameters.
Backport of c14b6b52ff131db263bf06a02f903a73390975da from master
Diffstat (limited to 'docs')
| -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 0ff763e064..e42ea79bfe 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -325,7 +325,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 @@ -373,7 +373,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 |