From b2ede89337f613caacdfe34f34df69b25e9b104f Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 12 Nov 2018 16:44:22 +0100 Subject: [2.1.x] Doc'd PermissionsMixin's usage of User.is_active and is_superuser. Backport of b1243a55a5916ed08a726b011bc05d40f717ef40 from master. --- docs/topics/auth/customizing.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index 963bbd3176..b5cb3cf6c1 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -925,8 +925,9 @@ methods and attributes: Returns ``True`` if the user has the specified permission, where ``perm`` is in the format ``"."`` (see - :ref:`permissions `). If the user is inactive, this method will - always return ``False``. + :ref:`permissions `). 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 - ``"."``. If the user is inactive, - this method will always return ``False``. + ``"."``. 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`` -- cgit v1.3