From 6bcac18e7e34835422e1a1abdfedb215cbc11d69 Mon Sep 17 00:00:00 2001 From: eofs Date: Tue, 15 Jan 2013 12:57:15 +0200 Subject: [PATCH] Docs updated --- docs/api-guide/serializers.md | 2 +- docs/api-guide/settings.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 4bc822d41..c9657afdd 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -245,7 +245,7 @@ All the relational fields may be used for any relationship or reverse relationsh ## Reverse relational fields -By default reverse relational fields are not displayed when ModelSerializer is used. You can control this behavior by using `INCLUDE_REVERSE_RELATIONS` setting. +By default reverse relational fields are not displayed when ModelSerializer is used. You can control this behavior by using `DEFAULT_INCLUDE_REVERSE_RELATIONS` setting. Besides global setting you can also use model specific setting: diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index a422e5f61..984c00d35 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -96,6 +96,12 @@ Default: `rest_framework.serializers.ModelSerializer` Default: `rest_framework.pagination.PaginationSerializer` +## DEFAULT_INCLUDE_REVERSE_RELATIONS + +If set to `True`, ModelSerializer will display reverse relational fields from other models. + +Default: `False` + ## FILTER_BACKEND The filter backend class that should be used for generic filtering. If set to `None` then generic filtering is disabled.