summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Amalthea Magnuson <markus@polyscopic.works>2023-11-14 10:39:02 +0100
committerNatalia Bidart <124304+nessita@users.noreply.github.com>2023-11-15 21:52:11 -0300
commit8c88ae8251da7f4fa01c1422f76fbb73aa41fffa (patch)
tree55cb8ba143992d8e17af130945d7ec1d781f992e /docs
parenta5ee682baf31755ce1c1121d116e6d7e9cd486ef (diff)
[5.0.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.
Backport of 61c305f298da1b4079a80721c861d0663dc8717e from main
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/auth/passwords.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt
index 0876ac4f6e..3b42efeac0 100644
--- a/docs/topics/auth/passwords.txt
+++ b/docs/topics/auth/passwords.txt
@@ -526,8 +526,9 @@ can write your own as well.
Each password validator must provide a help text to explain the requirements to
the user, validate a given password and return an error message if it does not
-meet the requirements, and optionally receive passwords that have been set.
-Validators can also have optional settings to fine tune their behavior.
+meet the requirements, and optionally define a callback to be notified when
+the password for a user has been changed. Validators can also have optional
+settings to fine tune their behavior.
Validation is controlled by the :setting:`AUTH_PASSWORD_VALIDATORS` setting.
The default for the setting is an empty list, which means no validators are