summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSrinivas Reddy Thatiparthy <thatiparthysreenivas@gmail.com>2018-05-25 20:53:13 +0530
committerTim Graham <timograham@gmail.com>2018-05-25 15:10:45 -0400
commit4c35a173e881deaff17e5343181dcbc36177a4af (patch)
treece3365ce13292919f758279c9fcc5dc13c3734d4 /docs
parent738a0a4dc289d7a9c67199687519712ca0bfafd1 (diff)
Fixed #29423 -- Documented Field.value_from_object().
Diffstat (limited to 'docs')
-rw-r--r--docs/howto/custom-model-fields.txt4
-rw-r--r--docs/ref/models/fields.txt6
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt
index 8ecfee8709..9d7e28b164 100644
--- a/docs/howto/custom-model-fields.txt
+++ b/docs/howto/custom-model-fields.txt
@@ -679,8 +679,8 @@ Converting field data for serialization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To customize how the values are serialized by a serializer, you can override
-:meth:`~Field.value_to_string`. Using ``value_from_object()`` is the best way
-to get the field's value prior to serialization. For example, since our
+:meth:`~Field.value_to_string`. Using :meth:`~Field.value_from_object` is the
+best way to get the field's value prior to serialization. For example, since
``HandField`` uses strings for its data storage anyway, we can reuse some
existing conversion code::
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index c696b770b3..5fc785fb18 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1857,6 +1857,12 @@ Field API reference
Besides saving to the database, the field also needs to know how to
serialize its value:
+ .. method:: value_from_object(obj)
+
+ Returns the field's value for the given model instance.
+
+ This method is often used by :meth:`value_to_string`.
+
.. method:: value_to_string(obj)
Converts ``obj`` to a string. Used to serialize the value of the field.