diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 4 | ||||
| -rw-r--r-- | docs/ref/paginator.txt | 8 | ||||
| -rw-r--r-- | docs/releases/6.0.txt | 4 |
3 files changed, 15 insertions, 1 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 24831951a7..37730ca982 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -31,6 +31,10 @@ details on these changes. * Support for setting the ``ADMINS`` or ``MANAGERS`` settings to a list of (name, address) tuples will be removed. +* The ``orphans`` argument being larger than or equal to the ``per_page`` + argument of ``django.core.paginator.Paginator`` and + ``django.core.paginator.AsyncPaginator`` will no longer be allowed. + .. _deprecation-removed-in-6.1: 6.1 diff --git a/docs/ref/paginator.txt b/docs/ref/paginator.txt index d5b5b0f30e..5acd3d87c2 100644 --- a/docs/ref/paginator.txt +++ b/docs/ref/paginator.txt @@ -48,7 +48,13 @@ For examples, see the :doc:`Pagination topic guide </topics/pagination>`. themselves. For example, with 23 items, ``per_page=10``, and ``orphans=3``, there will be two pages; the first page with 10 items and the second (and last) page with 13 items. ``orphans`` defaults to zero, which means - pages are never combined and the last page may have one item. + pages are never combined and the last page may have one item. ``orphans`` + should be less than the :attr:`~Paginator.per_page` value. + + .. deprecated:: 6.0 + + Support for the ``orphans`` argument being larger than or equal to the + ``per_page`` argument is deprecated. .. attribute:: Paginator.allow_empty_first_page diff --git a/docs/releases/6.0.txt b/docs/releases/6.0.txt index da69c73044..cd72185354 100644 --- a/docs/releases/6.0.txt +++ b/docs/releases/6.0.txt @@ -336,6 +336,10 @@ Miscellaneous never used the name portion. To include a name, format the address string as ``'"Name" <address>'`` or use Python's :func:`email.utils.formataddr`. +* Support for the ``orphans`` argument being larger than or equal to the + ``per_page`` argument of :class:`django.core.paginator.Paginator` and + :class:`django.core.paginator.AsyncPaginator` is deprecated. + Features removed in 6.0 ======================= |