diff options
| author | Zan Anderle <zan.anderle@gmail.com> | 2014-10-30 20:45:01 +0100 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2014-10-30 18:18:39 -0400 |
| commit | 9e3aaa5a46b5ecc099d518bc01c7433d5c9efdef (patch) | |
| tree | 5d0c2c23fa88b2b0be8dbbc59d24c4e7780fbe60 | |
| parent | 8f79c154ca19c3a4b70da044df2489e6765cb814 (diff) | |
Explained why admindocs omits model methods with arguments.
| -rw-r--r-- | docs/ref/contrib/admin/admindocs.txt | 11 |
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 ======== |
