From 22c5b863bc395a6df84ec2536849540d3e92da7a Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Mon, 1 Dec 2014 11:37:38 +0000
Subject: More descriptive docstring on ModelSerializer

---
 rest_framework/serializers.py | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'rest_framework')

diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py
index de0d026d..3783b285 100644
--- a/rest_framework/serializers.py
+++ b/rest_framework/serializers.py
@@ -565,6 +565,14 @@ class ModelSerializer(Serializer):
     * A set of default fields are automatically populated.
     * A set of default validators are automatically populated.
     * Default `.create()` and `.update()` implementations are provided.
+
+    The process of automatically determining a set of serializer fields
+    based on the model fields is reasonably complex, but you almost certainly
+    don't need to dig into the implemention.
+
+    If the `ModelSerializer` class *doesn't* generate the set of fields that
+    you need you should either declare the extra/differing fields explicitly on
+    the serializer class, or simply use a `Serializer` class.
     """
     _field_mapping = ClassLookupDict({
         models.AutoField: IntegerField,
-- 
cgit v1.2.3