Fixed #19712 - Clarified admindocs regarding which attributes appear.

Thanks Daniele Procida for the report.
This commit is contained in:
Tim Graham 2013-05-16 05:55:21 -04:00
parent 0a29057ebe
commit b5b63079bd
1 changed files with 4 additions and 3 deletions

View File

@ -57,9 +57,10 @@ Model reference
=============== ===============
The **models** section of the ``admindocs`` page describes each model in the 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 system along with all the fields and methods (without any arguments) available
other models appear as hyperlinks. Descriptions are pulled from ``help_text`` on it. While model properties don't have any arguments, they are not listed.
attributes on fields or from docstrings on model methods. 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:: A model with useful documentation might look like this::