Skip to content

Commit

Permalink
[1.5.x] Fixed #19712 - Clarified admindocs regarding which attributes…
Browse files Browse the repository at this point in the history
… appear.

Thanks Daniele Procida for the report.

Backport of b5b6307 from master
  • Loading branch information
timgraham committed May 16, 2013
1 parent 7f42692 commit a9048c4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/ref/contrib/admin/admindocs.txt
Expand Up @@ -57,9 +57,10 @@ Model reference
===============

The **models** section of the ``admindocs`` page describes each model in the
system along with all the fields and methods available on it. Relationships to
other models appear as hyperlinks. Descriptions are pulled from ``help_text``
attributes on fields or from docstrings on model methods.
system along with all the fields and methods (without any arguments) available
on it. While model properties don't have any arguments, they are not listed.
Relationships to other models appear as hyperlinks. Descriptions are pulled
from ``help_text`` attributes on fields or from docstrings on model methods.

A model with useful documentation might look like this::

Expand Down

0 comments on commit a9048c4

Please sign in to comment.