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>2014-10-30 18:19:51 -0400
commit5fa841d22f502c1a8d3c5590327025fca0e34438 (patch)
tree62c3f31f7049f5a1a25ff1ab3acd17d76a2a6eb0 /docs
parent28033632f8533a16943bda816ed11ed3b2773b05 (diff)
[1.6.x] Explained why admindocs omits model methods with arguments.
Backport of 9e3aaa5a46 from master
Diffstat (limited to 'docs')
-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 6deb7bdbf8..3573dff6ac 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
========