From b6aa60f4252311ef8ef24b4ffd99984197be7ee6 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 18 Aug 2014 12:49:50 -0400 Subject: [PATCH] Fixed #14638 -- Clarified model Field.to_python() docs. Thanks Anubhav Joshi for the patch. --- docs/howto/custom-model-fields.txt | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt index 5a6047c58fe..f24746c2f0a 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 `. When saving a ModelForm, Django will use