summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorSimon Meers <simon@simonmeers.com>2010-10-09 02:54:48 +0000
committerSimon Meers <simon@simonmeers.com>2010-10-09 02:54:48 +0000
commitfa3335fa9f5af4b1ff3991b87ebac3449ceae6b2 (patch)
treee3d38174d3c12b3bda980e956dadb5ad6ae3a057 /docs/ref
parent5b155e2a879faedc8f72b3756e20a77b79a209f4 (diff)
Fixed #5537 -- document trailing '+' on related_name for supressing backward relation.
Thanks to dcramer for the report, and Russ for pointing out the workaround. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14049 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/models/fields.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 68208b3bfe..a390b4b843 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -925,6 +925,15 @@ define the details of how the relation works.
<abstract-base-classes>`; and when you do so
:ref:`some special syntax <abstract-related-name>` is available.
+ If you wish to supress the provision of a backwards relation, you may
+ simply provide a ``related_name`` which ends with a '+' character.
+ For example::
+
+ user = models.ForeignKey(User, related_name='+')
+
+ will ensure that no backwards relation to this model is provided on the
+ ``User`` model.
+
.. attribute:: ForeignKey.to_field
The field on the related object that the relation is to. By default, Django