Browse Source

Fixed #29423 -- Documented Field.value_from_object().

Srinivas Reddy Thatiparthy 6 years ago
parent
commit
4c35a173e8
2 changed files with 8 additions and 2 deletions
  1. 2 2
      docs/howto/custom-model-fields.txt
  2. 6 0
      docs/ref/models/fields.txt

+ 2 - 2
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::
 

+ 6 - 0
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.