aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/fields.md
diff options
context:
space:
mode:
authorTom Christie2013-06-04 20:23:16 +0100
committerTom Christie2013-06-04 20:23:16 +0100
commitffa27b840f66d24562de9f66a9ac7a4142da51db (patch)
treea950efe77a052e8d98b98b7fdc1ceb88599311e8 /docs/api-guide/fields.md
parentc160e49321d77c6b1b99fc898e2624760edc137b (diff)
downloaddjango-rest-framework-ffa27b840f66d24562de9f66a9ac7a4142da51db.tar.bz2
Fix ModelField docs. Closes #909.
Diffstat (limited to 'docs/api-guide/fields.md')
-rw-r--r--docs/api-guide/fields.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index c7db32ed..94fff7e2 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=<Django ModelField class>)`
+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=<Django ModelField instance>)`
## SerializerMethodField