Improve documentation for the MinimumPasswordLengthToLogin policy

[lhc/web/wiklou.git] / includes / password / PasswordPolicyChecks.php

diff --git a/includes/password/PasswordPolicyChecks.php b/includes/password/PasswordPolicyChecks.php
index 502f1e0..cec82c7 100644 (file)
--- a/includes/password/PasswordPolicyChecks.php
+++ b/includes/password/PasswordPolicyChecks.php
@@ -44,7 +44,9 @@ class PasswordPolicyChecks {
        }
 
        /**
-        * Check password is longer than minimum, fatal
+        * Check password is longer than minimum, fatal.
+        * Intended for locking out users with passwords too short to trust, requiring them
+        * to recover their account by some other means.
         * @param int $policyVal minimal length
         * @param User $user
         * @param string $password