summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-03-31 03:59:34 -0400
committerTim Graham <timograham@gmail.com>2013-03-31 03:59:34 -0400
commitac4d82b94a700214ebb13bcdcbbdd4fd9bdefc0f (patch)
tree756e9f520a8f72f84e9ec99bd89afc37c245cf60
parentc119d0f152e939420613868294d58fa4b902e18a (diff)
Fixed #9913 - Clarified User.is_authenticated docs.
Thanks rshea for the draft text.
-rw-r--r--docs/ref/contrib/auth.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt
index 6ec6af607a..40b3629f63 100644
--- a/docs/ref/contrib/auth.txt
+++ b/docs/ref/contrib/auth.txt
@@ -111,10 +111,14 @@ Methods
.. method:: is_authenticated()
- Always returns ``True``. 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 the user has provided a
- valid username and password.
+ 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.
.. method:: get_full_name()