Clarify meaning of models.User.is_authenticated()

This commit is contained in:
Jaime Irurzun 2013-08-08 12:45:06 +01:00
parent 7a2296eb5b
commit f96fe3cd1e
1 changed files with 7 additions and 5 deletions

View File

@ -114,11 +114,13 @@ Methods
Always returns ``True`` (as opposed to Always returns ``True`` (as opposed to
``AnonymousUser.is_authenticated()`` which always returns ``False``). ``AnonymousUser.is_authenticated()`` which always returns ``False``).
This is a way to tell if the user has been authenticated. This does not 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 imply any permissions, and doesn't check if the user is active or has
only indicates that ``request.user`` has been populated by the a valid session. Even though normally you will call this method on
:class:`~django.contrib.auth.middleware.AuthenticationMiddleware` with ``request.user`` to find out whether it has been populated by the
a :class:`~django.contrib.auth.models.User` object representing the :class:`~django.contrib.auth.middleware.AuthenticationMiddleware`
currently logged-in user. (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() .. method:: get_full_name()