Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

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

… appear.

Thanks Daniele Procida for the report.

Backport of b5b6307 from master
  • Loading branch information...
commit a9048c40edffd189e9b99699c5947e69f9ca15f1 1 parent 7f42692
@timgraham timgraham authored
Showing with 4 additions and 3 deletions.
  1. +4 −3 docs/ref/contrib/admin/admindocs.txt
View
7 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::
Please sign in to comment.
Something went wrong with that request. Please try again.