summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid D Lowe <daviddlowe.flimm@gmail.com>2024-10-23 18:20:36 +0100
committerGitHub <noreply@github.com>2024-10-23 14:20:36 -0300
commitde2bb73904009313bae3664ef71edfd60df9912b (patch)
tree785477d0a3aa240e8bfe07e1c011a6e1dfac9121 /docs
parent4d11ea1ef01eba14b3a48a727f07f723f782fd84 (diff)
Doc'd that unusable passwords are defined by metadata in the password field.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/auth.txt8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt
index c8699a2913..103aff8e0b 100644
--- a/docs/ref/contrib/auth.txt
+++ b/docs/ref/contrib/auth.txt
@@ -54,7 +54,8 @@ Fields
Required. A hash of, and metadata about, the password. (Django doesn't
store the raw password.) Raw passwords can be arbitrarily long and can
- contain any character. See the :doc:`password documentation
+ contain any character. The metadata in this field may mark the password
+ as unusable. See the :doc:`password documentation
</topics/auth/passwords>`.
.. attribute:: groups
@@ -175,8 +176,9 @@ Methods
.. method:: set_unusable_password()
- Marks the user as having no password set. This isn't the same as
- having a blank string for a password.
+ Marks the user as having no password set by updating the metadata in
+ the :attr:`~django.contrib.auth.models.User.password` field. This isn't
+ the same as having a blank string for a password.
:meth:`~django.contrib.auth.models.User.check_password()` for this user
will never return ``True``. Doesn't save the
:class:`~django.contrib.auth.models.User` object.