summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZan Anderle <zan.anderle@gmail.com>2014-10-30 20:45:01 +0100
committerTim Graham <timograham@gmail.com>2014-10-30 18:19:48 -0400
commit30bd586a1c140216760ad89d4bd3170e9fdf26cf (patch)
tree84147cc5da99c6b53cd9b6b33ce4bfcdb2d4181a
parentaca514b7c4a9051d8a5eb4cebf3737ab01b98f40 (diff)
[1.7.x] Explained why admindocs omits model methods with arguments.
Backport of 9e3aaa5a46 from master
-rw-r--r--docs/ref/contrib/admin/admindocs.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt
index c5386c5b2f..6e2ca745cf 100644
--- a/docs/ref/contrib/admin/admindocs.txt
+++ b/docs/ref/contrib/admin/admindocs.txt
@@ -12,9 +12,14 @@ docstrings of models, views, template tags, and template filters for any app in
:setting:`INSTALLED_APPS` and makes that documentation available from the
:mod:`Django admin <django.contrib.admin>`.
-In addition to providing offline documentation for all template tags and
-template filters that ship with Django, you may utilize admindocs to quickly
-document your own code.
+You may, to some extent, utilize :mod:`~django.contrib.admindocs` to quickly
+document your own code. This has limited usage, however, as the app is
+primarily intended for documenting templates, template tags, and filters.
+For example, model methods that require arguments are purposefully omitted
+from the documentation because they can't be invoked from templates. The app
+can still be useful since it doesn't require you to write any extra
+documentation (besides docstrings) and is conveniently available from the
+:mod:`Django admin <django.contrib.admin>`.
Overview
========