aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Christie2013-05-18 07:22:22 -0700
committerTom Christie2013-05-18 07:22:22 -0700
commite1a3cab40092932832812bd343529f957fdece0a (patch)
tree4866ec8086ac5e0e2c4696fe96d66812775eb95d /docs
parentcc39b9c9256896c5106b7f265af77f8db8a9f2b5 (diff)
parent0b84c5a0acef23b0b9be920cfb8926c095ae9ac2 (diff)
downloaddjango-rest-framework-e1a3cab40092932832812bd343529f957fdece0a.tar.bz2
Merge pull request #854 from ryankask/issue-775
All relations pointing to ManyToManyFields should default to read-only
Diffstat (limited to 'docs')
-rw-r--r--docs/api-guide/relations.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md
index 155c89de..99fe1083 100644
--- a/docs/api-guide/relations.md
+++ b/docs/api-guide/relations.md
@@ -381,6 +381,15 @@ Note that reverse generic keys, expressed using the `GenericRelation` field, can
For more information see [the Django documentation on generic relations][generic-relations].
+## ManyToManyFields with a Through Model
+
+By default, relational fields that target a ``ManyToManyField`` with a
+``through`` model specified are set to read-only.
+
+If you exlicitly specify a relational field pointing to a
+``ManyToManyField`` with a through model, be sure to set ``read_only``
+to ``True``.
+
## Advanced Hyperlinked fields
If you have very specific requirements for the style of your hyperlinked relationships you can override `HyperlinkedRelatedField`.