[2.1.x] Doc'd PermissionsMixin's usage of User.is_active and is_superuser.

Backport of b1243a55a5916ed08a726b011bc05d40f717ef40 from master.
This commit is contained in:
Tobias Bengfort 2018-11-12 16:44:22 +01:00 committed by Tim Graham
parent ae35cd3dcb
commit b2ede89337

View File

@ -925,8 +925,9 @@ methods and attributes:
Returns ``True`` if the user has the specified permission, where
``perm`` is in the format ``"<app label>.<permission codename>"`` (see
:ref:`permissions <topic-authorization>`). If the user is inactive, this method will
always return ``False``.
:ref:`permissions <topic-authorization>`). If :attr:`.User.is_active`
and :attr:`~.User.is_superuser` are both ``True``, this method always
returns ``True``.
If ``obj`` is passed in, this method won't check for a permission for
the model, but for this specific object.
@ -935,8 +936,9 @@ methods and attributes:
Returns ``True`` if the user has each of the specified permissions,
where each perm is in the format
``"<app label>.<permission codename>"``. If the user is inactive,
this method will always return ``False``.
``"<app label>.<permission codename>"``. If :attr:`.User.is_active` and
:attr:`~.User.is_superuser` are both ``True``, this method always
returns ``True``.
If ``obj`` is passed in, this method won't check for permissions for
the model, but for the specific object.
@ -944,8 +946,9 @@ methods and attributes:
.. method:: models.PermissionsMixin.has_module_perms(package_name)
Returns ``True`` if the user has any permissions in the given package
(the Django app label). If the user is inactive, this method will
always return ``False``.
(the Django app label). If :attr:`.User.is_active` and
:attr:`~.User.is_superuser` are both ``True``, this method always
returns ``True``.
.. admonition:: ``PermissionsMixin`` and ``ModelBackend``