diff options
| author | Tom Christie <tom@tomchristie.com> | 2012-10-25 10:31:14 +0100 |
|---|---|---|
| committer | Tom Christie <tom@tomchristie.com> | 2012-10-25 10:31:14 +0100 |
| commit | 502be865c68635d5c31fa3fa58162b48412153ad (patch) | |
| tree | 872184b4f5d584361cc4727aadb459ea0d321c7c /docs | |
| parent | da56e1bac6449daef9aeab8d076d2594d9fd5b44 (diff) | |
Add 'page_kwarg' attribute to `MultipleObjectMixin`, removing hardcoded 'page'.
Diffstat (limited to 'docs')
| -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 |