summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-08-08 07:27:08 -0700
committerTim Graham <timograham@gmail.com>2013-08-08 07:27:08 -0700
commit58e4fe464cadeaab53b08511dceb5b0e2b82ebd1 (patch)
tree29167ca65813c2438df3f76f1d63a6a1c2b6b67b /docs/ref
parent7e6af9d40ce0232deb9d4c6943beef0b62a20a08 (diff)
parentf96fe3cd1eb56bdd4433f76a933a98915ea25ece (diff)
Merge pull request #1457 from jaimeirurzun/master
Clarified meaning of models.User.is_authenticated()
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/auth.txt12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt
index 477ee10d5f..4fe87e9872 100644
--- a/docs/ref/contrib/auth.txt
+++ b/docs/ref/contrib/auth.txt
@@ -114,11 +114,13 @@ Methods
Always returns ``True`` (as opposed to
``AnonymousUser.is_authenticated()`` which always returns ``False``).
This is a way to tell if the user has been authenticated. This does not
- imply any permissions, and doesn't check if the user is active - it
- only indicates that ``request.user`` has been populated by the
- :class:`~django.contrib.auth.middleware.AuthenticationMiddleware` with
- a :class:`~django.contrib.auth.models.User` object representing the
- currently logged-in user.
+ imply any permissions, and doesn't check if the user is active or has
+ a valid session. Even though normally you will call this method on
+ ``request.user`` to find out whether it has been populated by the
+ :class:`~django.contrib.auth.middleware.AuthenticationMiddleware`
+ (representing the currently logged-in user), you should know this method
+ returns ``True`` for any :class:`~django.contrib.auth.models.User`
+ instance.
.. method:: get_full_name()