summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-02-28 16:53:06 -0500
committerTim Graham <timograham@gmail.com>2015-03-02 18:45:52 -0500
commit5ebe921a8e4ea947580467b904105e14cbef3071 (patch)
tree8a1a246507d6118e9bb391b709a50d682248a777 /docs
parentedb5c9a01e0312eb23a955e13282c93d4ec9b097 (diff)
[1.7.x] Fixed #13015 -- Clarified language about model instances attached to forms.
Backport of a40a34a4b2d79dbf798df538c26222148d42b17c from master
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/forms/modelforms.txt21
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/topics/forms/modelforms.txt b/docs/topics/forms/modelforms.txt
index 57934dfe90..223f740a80 100644
--- a/docs/topics/forms/modelforms.txt
+++ b/docs/topics/forms/modelforms.txt
@@ -232,7 +232,7 @@ Overriding the clean() method
You can override the ``clean()`` method on a model form to provide additional
validation in the same way you can on a normal form.
-A model form instance bound to a model object will contain an ``instance``
+A model form instance attached to a model object will contain an ``instance``
attribute that gives its methods access to that specific model instance.
.. warning::
@@ -681,6 +681,21 @@ There are a couple of things to note, however.
a default field. To opt-out from default fields, see
:ref:`controlling-fields-with-fields-and-exclude`.
+Providing initial values
+------------------------
+
+As with regular forms, it's possible to specify initial data for forms by
+specifying an ``initial`` parameter when instantiating the form. Initial
+values provided this way will override both initial values from the form field
+and values from an attached model instance. For example::
+
+ >>> article = Article.objects.get(pk1=)
+ >>> article.headline
+ 'My headline'
+ >>> form = ArticleForm(initial={'headline': 'Initial headline'), instance=article)
+ >>> form['pub_date'].value()
+ 'Initial headline'
+
.. _modelforms-factory:
ModelForm factory function
@@ -853,8 +868,8 @@ As with regular formsets, it's possible to :ref:`specify initial data
<formsets-initial-data>` for forms in the formset by specifying an ``initial``
parameter when instantiating the model formset class returned by
:func:`~django.forms.models.modelformset_factory`. However, with model
-formsets, the initial values only apply to extra forms, those that aren't bound
-to an existing object instance.
+formsets, the initial values only apply to extra forms, those that aren't
+attached to an existing model instance.
.. _saving-objects-in-the-formset: