Description for REGISTER_VERIFICATION_ONE_TIME_USE

Based on [this message](#44 (comment))
apragacz · Jan 3, 2025 · 09f1842 · 09f1842
1 parent ac9459c
commit 09f1842
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/rest_registration/settings_fields.py b/rest_registration/settings_fields.py
@@ -181,7 +181,15 @@ def __new__(
             to create the activation link for newly registered user.
             """),
     ),
-    Field('REGISTER_VERIFICATION_ONE_TIME_USE', default=False),
+    Field(
+        'REGISTER_VERIFICATION_ONE_TIME_USE',
+        default=False,
+        help=dedent("""\
+            This setting ensures the activation link can only be used once.
+            If REGISTER_VERIFICATION_AUTO_LOGIN is enabled, the link could auto-login 
+            the user, which may not be desired.
+            """),
+    ),
     Field(
         'REGISTER_VERIFICATION_EMAIL_TEMPLATES',
         default={