[1.4.X] Fixed #9471 - Expanded ModelAdmin.raw_id_fields docs; thanks …

…adroffne for the suggestion. Backport of da958eb from master
django · Oct 24, 2012 · baf1f1d · baf1f1d
1 parent ce168bb
commit baf1f1d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/ref/contrib/admin/_images/raw_id_fields.png b/docs/ref/contrib/admin/_images/raw_id_fields.png
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
@@ -814,6 +814,14 @@ subclass::
         class ArticleAdmin(admin.ModelAdmin):
             raw_id_fields = ("newspaper",)
 
+    The ``raw_id_fields`` ``Input`` widget should contain a primary key if the
+    field is a ``ForeignKey`` or a comma separated list of values if the field
+    is a ``ManyToManyField``.  The ``raw_id_fields`` widget shows a magnifying
+    glass button next to the field which allows users to search for and select
+    a value:
+
+    .. image:: _images/raw_id_fields.png
+
 .. attribute:: ModelAdmin.readonly_fields
 
     .. versionadded:: 1.2