Django

Code

Changeset 9179

Show
Ignore:
Timestamp:
10/06/08 06:26:59 (3 months ago)
Author:
mtredinnick
Message:

[1.0.X] Fixed #7011 -- Clarified what User.is_active really means in the documentation.

Backport of r9176 from trunk.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/branches/releases/1.0.X/docs/topics/auth.txt

    r8843 r9179  
    9090    .. attribute:: models.User.is_active 
    9191 
    92         Boolean. Designates whether this account can be used to log in. Set this 
    93         flag to ``False`` instead of deleting accounts. 
     92        Boolean. Designates whether this user account should be considered 
     93        active. Set this flag to ``False`` instead of deleting accounts. 
     94 
     95        This doesn't control whether or not the user can log in. Nothing in 
     96        the authentication path checks the ``is_active`` flag, so if you want 
     97        to reject a login based on ``is_active`` being ``False``, it is up to 
     98        you to check that in your own login view. However, permission checking 
     99        using the methods like :meth:`~models.User.has_perm` does check this 
     100        flag and will always return ``False`` for inactive users. 
    94101 
    95102    .. attribute:: models.User.is_superuser