diff options
| author | Tom Christie <tom@tomchristie.com> | 2012-10-25 10:31:14 +0100 |
|---|---|---|
| committer | Jannis Leidel <jannis@leidel.info> | 2012-11-17 21:30:22 +0100 |
| commit | 2bfea3620842103d76972a17d77c3b75b4d30b86 (patch) | |
| tree | 2058ed6e68fc7feacabbf957464906ba35496afa /docs/ref | |
| parent | 94208399d958e0e9028d61d76f1b877eb3a8f74d (diff) | |
[1.5.x] Add 'page_kwarg' attribute to `MultipleObjectMixin`, removing hardcoded 'page'.
(cherry picked from commit 502be865c68635d5c31fa3fa58162b48412153ad)
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/class-based-views/mixins-multiple-object.txt | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/ref/class-based-views/mixins-multiple-object.txt b/docs/ref/class-based-views/mixins-multiple-object.txt index cdb743fcbd..e6abf26e6a 100644 --- a/docs/ref/class-based-views/mixins-multiple-object.txt +++ b/docs/ref/class-based-views/mixins-multiple-object.txt @@ -69,8 +69,15 @@ MultipleObjectMixin An integer specifying how many objects should be displayed per page. If this is given, the view will paginate objects with :attr:`MultipleObjectMixin.paginate_by` objects per page. The view will - expect either a ``page`` query string parameter (via ``GET``) or a - ``page`` variable specified in the URLconf. + expect either a ``page`` query string parameter (via ``request.GET``) + or a ``page`` variable specified in the URLconf. + + .. attribute:: page_kwarg + + A string specifying the name to use for the page parameter. + The view will expect this prameter to be available either as a query + string parameter (via ``request.GET``) or as a kwarg variable specified + in the URLconf. Defaults to ``"page"``. .. attribute:: paginator_class |