diff options
| author | Tanner Stirrat <tstirrat@gmail.com> | 2019-09-20 15:04:34 -0600 |
|---|---|---|
| committer | Carlton Gibson <carlton@noumenal.es> | 2019-10-02 09:49:31 +0200 |
| commit | 17595407ca456dc2f0cf3ddb5878ff75615c94ff (patch) | |
| tree | 89de288eb3def5f0457ed2dcac57cda3451143ba /docs/ref | |
| parent | 84322a29ce9b0940335f8ab3d60e55192bef1e50 (diff) | |
Fixed #14218 -- Added Paginator.__iter__().
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/paginator.txt | 11 |
1 files changed, 9 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) |