diff options
| author | Tim Graham <timograham@gmail.com> | 2013-05-16 05:55:21 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-05-16 08:34:19 -0400 |
| commit | a9048c40edffd189e9b99699c5947e69f9ca15f1 (patch) | |
| tree | 9f748716ad4020f21783cff539b85aeafae4bfee | |
| parent | 7f4269229cd6ca0ef94a34fd045e3ced9bdd57d0 (diff) | |
[1.5.x] Fixed #19712 - Clarified admindocs regarding which attributes appear.
Thanks Daniele Procida for the report.
Backport of b5b63079bd from master
| -rw-r--r-- | docs/ref/contrib/admin/admindocs.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index b3e26eca48..394d078e5b 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -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:: |