Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.0.X] Fixed #8861 -- Added note on the availability of ModelForm.in…

…stance. Thanks to Ramiro Morales for the patch.

Merge of r11097 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.0.X@11102 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit b287f8a96fc30e74d85d5c04836a557611b033cc 1 parent 34fbf19
@freakboy3742 freakboy3742 authored
Showing with 18 additions and 7 deletions.
  1. +4 −2 docs/ref/contrib/admin.txt
  2. +14 −5 docs/topics/forms/modelforms.txt
View
6 docs/ref/contrib/admin.txt
@@ -724,7 +724,7 @@ Adding custom validation to the admin
-------------------------------------
Adding custom validation of data in the admin is quite easy. The automatic admin
-interfaces reuses :mod:`django.forms`, and the ``ModelAdmin`` class gives you
+interface reuses :mod:`django.forms`, and the ``ModelAdmin`` class gives you
the ability define your own form::
class ArticleAdmin(admin.ModelAdmin):
@@ -744,7 +744,9 @@ any field::
It is important you use a ``ModelForm`` here otherwise things can break. See the
:ref:`forms <ref-forms-index>` documentation on :ref:`custom validation
-<ref-forms-validation>` for more information.
+<ref-forms-validation>` and, more specifically, the
+:ref:`model form validation notes <overriding-modelform-clean-method>` for more
+information.
.. _admin-inlines:
View
19 docs/topics/forms/modelforms.txt
@@ -370,11 +370,20 @@ 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. However, by default the
-``clean()`` method validates the uniqueness of fields that are marked as
-``unique``, ``unique_together`` or ``unique_for_date|month|year`` on the model.
-Therefore, if you would like to override the ``clean()`` method and maintain the
-default validation, you must call the parent class's ``clean()`` method.
+validation in the same way you can on a normal form.
+
+In this regard, model forms have two specific characteristics when compared to
+forms:
+
+By default the ``clean()`` method validates the uniqueness of fields that are
+marked as ``unique``, ``unique_together`` or ``unique_for_date|month|year`` on
+the model. Therefore, if you would like to override the ``clean()`` method and
+maintain the default validation, you must call the parent class's ``clean()``
+method.
+
+Also, a model form instance bound to a model object will contain a
+``self.instance`` attribute that gives model form methods access to that
+specific model instance.
Form inheritance
----------------
Please sign in to comment.
Something went wrong with that request. Please try again.