document SaveValidFormMixin

e-valuation · Oct 2, 2023 · 11c2493 · 11c2493
1 parent 73a5d22
commit 11c2493
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/evap/evaluation/tools.py b/evap/evaluation/tools.py
@@ -171,6 +171,13 @@ def formset_valid(self, formset):
 
 
 class SaveValidFormMixin:
+    """
+    Call `form.save()` if the submitted form is valid.
+
+    Django's `ModelFormMixin` (which inherits from `SingleObjectMixin`) does the same, but cannot always be used, for
+    example if a formset for a collection of objects is submitted.
+    """
+
     def form_valid(self, form):
         form.save()
         return super().form_valid(form)