p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #10367 -- Corrected an example in the documentation for GenericRelation. Thanks to George Song for the patch. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10659 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Russell Keith-Magee 2009-05-02 14:51:54 +00:00
parent 87d3ff731b
commit 95bcb70b56
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/ref/contrib/contenttypes.txt
View File

@ -313,7 +313,7 @@ referred to above used fields named ``content_type_fk`` and
``object_primary_key`` to create its generic foreign key, then a ``object_primary_key`` to create its generic foreign key, then a
``GenericRelation`` back to it would need to be defined like so:: ``GenericRelation`` back to it would need to be defined like so::
tags = generic.GenericRelation('content_type_fk', 'object_primary_key') tags = generic.GenericRelation(TaggedItem, content_type_field='content_type_fk', object_id_field='object_primary_key')
Of course, if you don't add the reverse relationship, you can do the Of course, if you don't add the reverse relationship, you can do the
same types of lookups manually:: same types of lookups manually::
@ -324,14 +324,14 @@ same types of lookups manually::
... object_id=b.id) ... object_id=b.id)
[<TaggedItem: django>, <TaggedItem: python>] [<TaggedItem: django>, <TaggedItem: python>]
Note that if the model with a :class:`~django.contrib.contenttypes.generic.GenericForeignKey` 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`` 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"``), (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 you'll need to pass ``content_type_field`` and ``object_id_field`` to
:class:`~django.contrib.contenttypes.generic.GenericRelation`.:: :class:`~django.contrib.contenttypes.generic.GenericRelation`.::
comments = generic.GenericRelation(Comment, content_type_field="content_type", object_id_field="object_pk") comments = generic.GenericRelation(Comment, content_type_field="content_type", object_id_field="object_pk")
Note that if you delete an object that has a Note that if you delete an object that has a
:class:`~django.contrib.contenttypes.generic.GenericRelation`, any objects :class:`~django.contrib.contenttypes.generic.GenericRelation`, any objects
which have a :class:`~django.contrib.contenttypes.generic.GenericForeignKey` which have a :class:`~django.contrib.contenttypes.generic.GenericForeignKey`
@ -342,7 +342,7 @@ it would be deleted at the same time.
Generic relations in forms and admin Generic relations in forms and admin
------------------------------------ ------------------------------------
:mod:`django.contrib.contenttypes.generic` provides both a :mod:`django.contrib.contenttypes.generic` provides both a
:class:`~django.contrib.contenttypes.generic.GenericInlineFormSet` :class:`~django.contrib.contenttypes.generic.GenericInlineFormSet`
and :class:`~django.contrib.contenttypes.generic.GenericInlineModelAdmin`. and :class:`~django.contrib.contenttypes.generic.GenericInlineModelAdmin`.
This enables the use of generic relations in forms and the admin. See the This enables the use of generic relations in forms and the admin. See the
@ -361,8 +361,8 @@ This enables the use of generic relations in forms and the admin. See the
The name of the The name of the
:class:`~django.contrib.contenttypes.models.ContentType` foreign key :class:`~django.contrib.contenttypes.models.ContentType` foreign key
field on the model. Defaults to ``content_type``. field on the model. Defaults to ``content_type``.
.. attribute:: generic.GenericInlineModelAdmin.ct_fk_field .. attribute:: generic.GenericInlineModelAdmin.ct_fk_field
The name of the integer field that represents the ID of the related The name of the integer field that represents the ID of the related
object. Defaults to ``object_id``. object. Defaults to ``object_id``.