Skip to content

Commit

Permalink
[5.0.x] Improved wording in auth.models.User field docs.
Browse files Browse the repository at this point in the history
Co-authored-by: Lily Foote <code@lilyf.org>

Backport of 79099a7 from main
  • Loading branch information
why-not-try-calmer authored and felixxm committed Dec 1, 2023
1 parent 471fa92 commit b8a476b
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/ref/contrib/auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ Fields

.. attribute:: is_staff

Boolean. Designates whether this user can access the admin site.
Boolean. Allows this user to access the admin site.

.. attribute:: is_active

Boolean. Designates whether this user account should be considered
active. We recommend that you set this flag to ``False`` instead of
deleting accounts; that way, if your applications have any foreign keys
to users, the foreign keys won't break.
Boolean. Marks this user account as active. We recommend that you set
this flag to ``False`` instead of deleting accounts. That way, if your
applications have any foreign keys to users, the foreign keys won't
break.

This doesn't necessarily control whether or not the user can log in.
Authentication backends aren't required to check for the ``is_active``
Expand All @@ -94,17 +94,16 @@ Fields

.. attribute:: is_superuser

Boolean. Designates that this user has all permissions without
explicitly assigning them.
Boolean. Treats this user as having all permissions without assigning
any permission to it in particular.

.. attribute:: last_login

A datetime of the user's last login.

.. attribute:: date_joined

A datetime designating when the account was created. Is set to the
current date/time by default when the account is created.
The date/time when the account was created.

Attributes
----------
Expand Down

0 comments on commit b8a476b

Please sign in to comment.