Clarify docs on controlling compound documents (#579)

django-json-api · Feb 25, 2019 · 95e7ed4 · 95e7ed4
1 parent 876892f
commit 95e7ed4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -23,3 +23,4 @@ Mohammed Ali Zubair <mazg1493@gmail.com>
 Jason Housley <housleyjk@gmail.com>
 Beni Keller <beni@matraxi.ch>
 Stas S. <stas@nerd.ro>
+Nathanael Gordon <nathanael.l.gordon@gmail.com>
diff --git a/docs/usage.md b/docs/usage.md
@@ -789,8 +789,9 @@ that are related to the primary resource.
 
 To make a Compound Document,
 you need to modify your `ModelSerializer`.
-The two required additions are `included_resources`
-and `included_serializers`.
+`included_serializers` is required to inform DJA of what and how you would like
+to include.
+`included_resources` tells DJA what you want to include by default.
 
 For example,
 suppose you are making an app to go on quests,
@@ -818,9 +819,6 @@ class QuestSerializer(serializers.ModelSerializer):
         included_resources = ['knight']
 ```
 
-`included_resources` informs DJA of **what** you would like to include.
-`included_serializers` tells DJA **how** you want to include it.
-
 #### Performance improvements
 
 Be aware that using included resources without any form of prefetching **WILL HURT PERFORMANCE** as it will introduce m\*(n+1) queries.