Changeset 5691

Timestamp:

07/13/07 16:20:07 (1 year ago)

Author:

adrian

Message:

Documented the 'commit' argument to save() methods on forms created via form_for_model() or form_for_instance()

Files:

• django/trunk/docs/newforms.txt (modified) (1 diff)

django/trunk/docs/newforms.txt

@@ -1496 +1496 @@
-doesn't validate -- i.e., ``if form.errors``.
-
+This ``save()`` method accepts an optional ``commit`` keyword argument, which
+accepts either ``True`` or ``False``. If you call ``save()`` with
+``commit=False``, then it will return an object that hasn't yet been saved to
+the database. In this case, it's up to you to call ``save()`` on the resulting
+model instance. This is useful if you want to do custom processing on the
+object before saving it. ``commit`` is ``True`` by default.
+
-Using an alternate base class
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~