From f96fe3cd1eb56bdd4433f76a933a98915ea25ece Mon Sep 17 00:00:00 2001 From: Jaime Irurzun Date: Thu, 8 Aug 2013 12:45:06 +0100 Subject: [PATCH] Clarify meaning of models.User.is_authenticated() --- docs/ref/contrib/auth.txt | 12 +++++++----- 1 file 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()