p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[1.5.x] Fixed #19712 - Clarified admindocs regarding which attributes appear. 

Thanks Daniele Procida for the report.

Backport of b5b63079bd from master
This commit is contained in:
Tim Graham 2013-05-16 05:55:21 -04:00
parent 7f4269229c
commit a9048c40ed
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/ref/contrib/admin/admindocs.txt
View File

@ -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::