Author: russellm
Date: 2010-08-07 10:01:38 -0500 (Sat, 07 Aug 2010)
New Revision: 13561
Modified:
django/branches/releases/1.2.X/docs/ref/contrib/contenttypes.txt
Log:
[1.2.X] Fixed #11047 -- Clarified the explanation of arguments to
GenericForeignKey. Thanks to psmith and timo for their work on the patch.
Backport of r13554 from trunk.
Modified: django/branches/releases/1.2.X/docs/ref/contrib/contenttypes.txt
===================================================================
--- django/branches/releases/1.2.X/docs/ref/contrib/contenttypes.txt
2010-08-07 15:01:17 UTC (rev 13560)
+++ django/branches/releases/1.2.X/docs/ref/contrib/contenttypes.txt
2010-08-07 15:01:38 UTC (rev 13561)
@@ -324,15 +324,19 @@
... object_id=b.id)
[<TaggedItem: django>, <TaggedItem: python>]
-Note that if the model with a
:class:`~django.contrib.contenttypes.generic.GenericForeignKey`
-that you're referring to uses a non-default value for ``ct_field`` or
``fk_field``
-(e.g. the :mod:`django.contrib.comments` app uses ``ct_field="object_pk"``),
-you'll need to pass ``content_type_field`` and ``object_id_field`` to
-:class:`~django.contrib.contenttypes.generic.GenericRelation`.::
+Note that if the model in a
+:class:`~django.contrib.contenttypes.generic.GenericRelation` uses a
+non-default value for ``ct_field`` or ``fk_field`` in its
+:class:`~django.contrib.contenttypes.generic.GenericForeignKey` (e.g. the
+:mod:`django.contrib.comments` app uses ``ct_field="object_pk"``),
+you'll need to set ``content_type_field`` and/or ``object_id_field`` in
+the :class:`~django.contrib.contenttypes.generic.GenericRelation` to
+match the ``ct_field`` and ``fk_field``, respectively, in the
+:class:`~django.contrib.contenttypes.generic.GenericForeignKey`::
- comments = generic.GenericRelation(Comment,
content_type_field="content_type", object_id_field="object_pk")
+ comments = generic.GenericRelation(Comment, object_id_field="object_pk")
-Note that if you delete an object that has a
+Note also, that if you delete an object that has a
:class:`~django.contrib.contenttypes.generic.GenericRelation`, any objects
which have a :class:`~django.contrib.contenttypes.generic.GenericForeignKey`
pointing at it will be deleted as well. In the example above, this means that
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
