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 04:01:05 -0400
commit930cd8eebb947239c84e8fd1c71294441c5abea3 (patch)
treee7dfd698d2346959395973ae16070627c5b532d7
parenta825b1903d355f8f7f41123fc36deb71d98db665 (diff)
[1.5.x] Fixed #9913 - Clarified User.is_authenticated docs.
Thanks rshea for the draft text. Backport of ac4d82b94a from master
-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 d5d4ff9c96..8a18501ab4 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()