Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Added a few notes about list_display to docs/model-api.txt

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 1d65ba62dbfb9e6f13bccbf03bf9444c6c6d6481 1 parent 473306a
@adrianholovaty adrianholovaty authored
Showing with 10 additions and 2 deletions.
  1. +10 −2 docs/model-api.txt
12 docs/model-api.txt
@@ -786,8 +786,11 @@ object, which takes the following parameters. All are optional.
There are a few special cases that do other things besides displaying the
contents of the given fields:
- * If the field given has a relationship, that relationship is
- followed and the ``repr()`` of the related object is displayed.
+ * If the field given is a ``ForeignKey``, the ``repr()`` of the related
+ object will be displayed.
+ * ``ManyToManyField`` fields aren't supported, because that would
+ entail executing a separate SQL statement for each row in the table.
* If the field is a ``BooleanField``, a "on" or "off" icon will
be displayed instead of ``True`` or ``False``.
@@ -797,6 +800,11 @@ object, which takes the following parameters. All are optional.
``short_description`` function attribute, for use as the header for
the field.
+ * Use the string ``"__repr__"`` to output the representation of the
+ object, according to your model's ``__repr__()`` function. If you
+ don't define ``list_display``, Django will use the ``__repr__`` by
+ default.
See the example below.

0 comments on commit 1d65ba6

Please sign in to comment.
Something went wrong with that request. Please try again.