diff options
| author | Jannis Leidel <jannis@leidel.info> | 2012-11-17 12:27:01 -0800 |
|---|---|---|
| committer | Jannis Leidel <jannis@leidel.info> | 2012-11-17 12:27:01 -0800 |
| commit | 778b8bdcf4fb2c7ddbf22ddbe8665001387b21ae (patch) | |
| tree | b083b3eb00c82af2d6c968b4d4f89c0bd254bf06 /docs | |
| parent | 730977046bb25c414a1cf5d665809224cc6b0cea (diff) | |
| parent | 3f2fc2f41abf226913517eb1e655f823f2c5e53a (diff) | |
Merge pull request #467 from tomchristie/page-kwarg
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 | 13 |
1 files changed, 11 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..fb5a1715e6 100644 --- a/docs/ref/class-based-views/mixins-multiple-object.txt +++ b/docs/ref/class-based-views/mixins-multiple-object.txt @@ -69,8 +69,17 @@ 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 + + .. versionadded:: 1.5 + + 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 |