summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2017-11-09 21:21:43 -0500
committerTim Graham <timograham@gmail.com>2017-11-09 21:22:03 -0500
commit3c8c3ff637e2c0c325e5638d2c56ae1938f0885d (patch)
tree274c06c429c8e24ae63bc06f046d8e16a446f7b7
parent36dd0126a5a9688530f099ab6cc4f8621d1494b3 (diff)
[2.0.x] Fixed #28777 -- Clarified the docs for admin.register's args.
Backport of abaf0ab4a444977dc8ac07b9b63256814c352245 from master
-rw-r--r--docs/ref/contrib/admin/index.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 8f729bee62..1120e7e670 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -123,9 +123,9 @@ The ``register`` decorator
class AuthorAdmin(admin.ModelAdmin):
pass
- It is given one or more model classes to register with the ``ModelAdmin``
- and an optional keyword argument ``site`` if you are not using the default
- ``AdminSite``::
+ It's given one or more model classes to register with the ``ModelAdmin``.
+ If you're using a custom :class:`AdminSite`, pass it using the ``site`` keyword
+ argument::
from django.contrib import admin
from .models import Author, Reader, Editor