diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/paginator.txt | 11 | ||||
| -rw-r--r-- | docs/releases/3.1.txt | 5 |
2 files changed, 14 insertions, 2 deletions
diff --git a/docs/ref/paginator.txt b/docs/ref/paginator.txt index 9ee6f0104c..877d6ba0d8 100644 --- a/docs/ref/paginator.txt +++ b/docs/ref/paginator.txt @@ -14,6 +14,13 @@ classes live in :source:`django/core/paginator.py`. .. class:: Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True) + A paginator acts like a sequence of :class:`Page` when using ``len()`` or + iterating it directly. + + .. versionchanged:: 3.1 + + Support for iterating over ``Paginator`` was added. + .. attribute:: Paginator.object_list Required. A list, tuple, ``QuerySet``, or other sliceable object with a @@ -98,8 +105,8 @@ Attributes ``Page`` class ============== -You usually won't construct ``Page`` objects by hand -- you'll get them using -:meth:`Paginator.page`. +You usually won't construct ``Page`` objects by hand -- you'll get them by +iterating :class:`Paginator`, or by using :meth:`Paginator.page`. .. class:: Page(object_list, number, paginator) diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt index da954bab56..d2078469ee 100644 --- a/docs/releases/3.1.txt +++ b/docs/releases/3.1.txt @@ -162,6 +162,11 @@ Models * ... +Pagination +~~~~~~~~~~ + +* Support for iterating over ``Paginator`` was added. + Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ |