summaryrefslogtreecommitdiff
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:51:32 -0300
commit47f9b8dca16b1fdc054b338d81eb080eabad0edf (patch)
treec59bdc3b719b90382ab8424392b53cf50bf16314
parentf1e004012ff4b32b8f8329183f4cffd1832e6c95 (diff)
[4.2.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.
Backport of 61c305f298da1b4079a80721c861d0663dc8717e from main
-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 695c8d2571..b7b2dd4f7a 100644
--- a/docs/topics/auth/passwords.txt
+++ b/docs/topics/auth/passwords.txt
@@ -519,8 +519,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