summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-07-08 12:08:30 -0400
committerTim Graham <timograham@gmail.com>2013-07-08 12:21:34 -0400
commit5567dc68e6fc7788cd9451e5fea52396ffaf3675 (patch)
treeaec8a83d7d6bbd5542ae37ca7468e515e4e2bd96 /docs/topics
parentf551d5a3de4f32f0b6322a1d884990e34ab67528 (diff)
[1.5.x] Fixed #16965 -- Clarified Formset can_delete docs.
Thanks gregcorey@ for the suggestion. Backport of 660c30ed95 from master
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/forms/formsets.txt13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/topics/forms/formsets.txt b/docs/topics/forms/formsets.txt
index 142ed380b5..ac8741d90a 100644
--- a/docs/topics/forms/formsets.txt
+++ b/docs/topics/forms/formsets.txt
@@ -323,7 +323,7 @@ happen when the user changes these values::
Default: ``False``
-Lets you create a formset with the ability to delete::
+Lets you create a formset with the ability to select forms for deletion::
>>> ArticleFormSet = formset_factory(ArticleForm, can_delete=True)
>>> formset = ArticleFormSet(initial=[
@@ -369,6 +369,13 @@ delete fields you can access them with ``deleted_forms``::
>>> [form.cleaned_data for form in formset.deleted_forms]
[{'DELETE': True, 'pub_date': datetime.date(2008, 5, 10), 'title': u'Article #1'}]
+If you are using a :class:`ModelFormSet<django.forms.models.BaseModelFormSet>`,
+model instances for deleted forms will be deleted when you call
+``formset.save()``. On the other hand, if you are using a plain ``FormSet``,
+it's up to you to handle ``formset.deleted_forms``, perhaps in your formset's
+``save()`` method, as there's no general notion of what it means to delete a
+form.
+
Adding additional fields to a formset
-------------------------------------
@@ -460,8 +467,8 @@ If you manually render fields in the template, you can render
</form>
-Similarly, if the formset has the ability to order (``can_order=True``), it is possible to render it
-with ``{{ form.ORDER }}``.
+Similarly, if the formset has the ability to order (``can_order=True``), it is
+possible to render it with ``{{ form.ORDER }}``.
Using more than one formset in a view
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~