summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2014-08-18 12:49:50 -0400
committerTim Graham <timograham@gmail.com>2014-08-18 12:53:25 -0400
commitb6aa60f4252311ef8ef24b4ffd99984197be7ee6 (patch)
tree34108db8c707acc7fa85306d38c49c6954667d0f
parent152afadef12e3dcb9ce92567d2e58269749d63b9 (diff)
Fixed #14638 -- Clarified model Field.to_python() docs.
Thanks Anubhav Joshi for the patch.
-rw-r--r--docs/howto/custom-model-fields.txt18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt
index 5a6047c58f..f24746c2f0 100644
--- a/docs/howto/custom-model-fields.txt
+++ b/docs/howto/custom-model-fields.txt
@@ -362,17 +362,17 @@ If you want your code to work on Python 2 & 3, you can use
class HandField(with_metaclass(models.SubfieldBase, models.Field)):
...
-This ensures that the :meth:`.to_python` method, documented below, will always
-be called when the attribute is initialized.
+This ensures that the :meth:`.to_python` method will always be called when the
+attribute is initialized.
-ModelForms and custom fields
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``ModelForm``\s and custom fields
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you use :class:`~django.db.models.SubfieldBase`, :meth:`.to_python`
-will be called every time an instance of the field is assigned a
-value. This means that whenever a value may be assigned to the field,
-you need to ensure that it will be of the correct datatype, or that
-you handle any exceptions.
+If you use :class:`~django.db.models.SubfieldBase`, :meth:`.to_python` will be
+called every time an instance of the field is assigned a value (in addition to
+its usual call when retrieving the value from the database). This means that
+whenever a value may be assigned to the field, you need to ensure that it will
+be of the correct datatype, or that you handle any exceptions.
This is especially important if you use :doc:`ModelForms
</topics/forms/modelforms>`. When saving a ModelForm, Django will use