Add detail about email_verification_required in UserRegister

incuna · Mar 24, 2015 · a47aa5b · a47aa5b
1 parent fc7f96f
commit a47aa5b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/user_management/api/views.py b/user_management/api/views.py
@@ -72,7 +72,8 @@ class UserRegister(generics.CreateAPIView):
     """
     Register a new `User`.
 
-    Register a user and send an email to validate the new account.
+    An email to validate the new account is sent if `email_verification_required`
+    is set to `True`.
     """
     serializer_class = serializers.RegistrationSerializer
     permission_classes = [permissions.IsNotAuthenticated]