summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZan Anderle <zan.anderle@gmail.com>2014-10-30 20:45:01 +0100
committerTim Graham <timograham@gmail.com>2015-09-07 15:07:39 -0400
commitf3dc173240d2a91c831b08dd6820e1d83322f3da (patch)
tree99567a09fd1818664a81f97b2491b9f43002df1a /docs
parent3c5862ccb0fc77418c3b20c21c6b57c40b483464 (diff)
Fixed #24917 -- Made admindocs display model methods that take arguments.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/admin/admindocs.txt13
-rw-r--r--docs/releases/1.9.txt6
2 files changed, 15 insertions, 4 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt
index 2d76748e02..241e12da36 100644
--- a/docs/ref/contrib/admin/admindocs.txt
+++ b/docs/ref/contrib/admin/admindocs.txt
@@ -60,10 +60,15 @@ Model reference
===============
The **models** section of the ``admindocs`` page describes each model in the
-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.
+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.
+
+.. versionchanged:: 1.9
+
+ The **models** section of the ``admindocs`` now describes methods that take
+ arguments as well. In previous versions it was restricted to methods
+ without arguments.
A model with useful documentation might look like this::
diff --git a/docs/releases/1.9.txt b/docs/releases/1.9.txt
index a0219bd370..04b5a6e781 100644
--- a/docs/releases/1.9.txt
+++ b/docs/releases/1.9.txt
@@ -163,6 +163,12 @@ Minor features
* JavaScript slug generation now supports Romanian characters.
+:mod:`django.contrib.admindocs`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* The model section of the ``admindocs`` now also describes methods that take
+ arguments, rather than ignoring them.
+
:mod:`django.contrib.auth`
^^^^^^^^^^^^^^^^^^^^^^^^^^