From 786cab705a37f6b2196560d0e476e5c849420a61 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 26 Nov 2014 11:38:48 +0000
Subject: Tweak to 3.0 relationship docs

---
 docs/api-guide/relations.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'docs/api-guide/relations.md')

diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md
index 7d19eba2..17009bbc 100644
--- a/docs/api-guide/relations.md
+++ b/docs/api-guide/relations.md
@@ -245,7 +245,7 @@ For example, the following serializer:
             fields = ('order', 'title')
 
     class AlbumSerializer(serializers.ModelSerializer):
-        tracks = TrackSerializer(many=True)
+        tracks = TrackSerializer(many=True, read_only=True)
 
         class Meta:
             model = Album
@@ -305,6 +305,16 @@ This custom field would then serialize to the following representation.
 
 # Further notes
 
+## The `queryset` argument
+
+The `queryset` argument is only ever required for *writable* relationship field, in which case it is used for performing the model instance lookup, that maps from the primitive user input, into a model instance.
+
+In version 2.x a serializer class could *sometimes* automatically determine the `queryset` argument *if* a `ModelSerializer` class was being used.
+
+This behavior is now replaced with *always* using an explicit `queryset` argument for writable relational fields.
+
+Doing so reduces the amount of hidden 'magic' that `ModelSerializer` provides, makes the behavior of the field more clear, and ensures that it is trivial to move between using the `ModelSerializer` shortcut, or using fully explicit `Serializer` classes.
+
 ## Reverse relations
 
 Note that reverse relationships are not automatically included by the `ModelSerializer` and `HyperlinkedModelSerializer` classes.  To include a reverse relationship, you must explicitly add it to the fields list.  For example:
-- 
cgit v1.2.3