diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index c7db32edf..94fff7e21 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -117,7 +117,9 @@ A field that supports both read and write operations. By itself `WritableField` A generic field that can be tied to any arbitrary model field. The `ModelField` class delegates the task of serialization/deserialization to it's associated model field. This field can be used to create serializer fields for custom model fields, without having to create a new custom serializer field. -**Signature:** `ModelField(model_field=)` +The `ModelField` class is generally intended for internal use, but can be used by your API if needed. In order to properly instantiate a `ModelField`, it must be passed a field that is attached to an instantiated model. For example: `ModelField(model_field=MyModel()._meta.get_field('custom_field'))` + +**Signature:** `ModelField(model_field=)` ## SerializerMethodField diff --git a/docs/index.md b/docs/index.md index d944ddd4b..0fb5706e1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@

- + -Travis build image +

# Django REST framework