Commit 42aee6ff authored by Tim Graham's avatar Tim Graham
Browse files

[1.4.x] Fixed #14885 - Clarified that ModelForm cleaning may not fully...

[1.4.x] Fixed #14885 - Clarified that ModelForm cleaning may not fully complete if the form is invalid.

Thanks Ben Sturmfels for the patch.

Backport of 3fd89d99 from master.
parent b05d2f51
Loading
Loading
Loading
Loading
+7 −4
Original line number Diff line number Diff line
@@ -200,10 +200,13 @@ The ``is_valid()`` method and ``errors``
----------------------------------------

The first time you call ``is_valid()`` or access the ``errors`` attribute of a
``ModelForm`` triggers form validation as well as :ref:`model validation
<validating-objects>`. This has the side-effect of cleaning the model you pass
to the ``ModelForm`` constructor. For instance, calling ``is_valid()`` on your
form will convert any date fields on your model to actual date objects.
``ModelForm`` triggers :ref:`form validation <form-and-field-validation>` as
well as :ref:`model validation <validating-objects>`. This has the side-effect
of cleaning the model you pass to the ``ModelForm`` constructor. For instance,
calling ``is_valid()`` on your form will convert any date fields on your model
to actual date objects. If form validation fails, only some of the updates
may be applied. For this reason, you'll probably want to avoid reusing the
model instance.


The ``save()`` method