From 650561ac25665124a4d0ef77657c9b0013842325 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Mon, 8 Feb 2021 23:38:55 +0000 Subject: [PATCH] Improved pagination documentation * Link to the topic guide * Document that page() can raise PageNotAnInteger. --- docs/ref/paginator.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/ref/paginator.txt b/docs/ref/paginator.txt index 7758234d6e356..e6d67755d092e 100644 --- a/docs/ref/paginator.txt +++ b/docs/ref/paginator.txt @@ -6,6 +6,8 @@ Django provides a few classes that help you manage paginated data -- that is, data that's split across several pages, with "Previous/Next" links. These classes live in :source:`django/core/paginator.py`. +For examples, see the :doc:`Pagination topic guide `. + .. module:: django.core.paginator :synopsis: Classes to help you easily manage paginated data. @@ -72,7 +74,9 @@ Methods .. method:: Paginator.page(number) Returns a :class:`Page` object with the given 1-based index. Raises - :exc:`InvalidPage` if the given page number doesn't exist. + :exc:`PageNotAnInteger` if the ``number`` cannot be converted to an integer + by calling ``int()``. Raises :exc:`InvalidPage` if the given page number + doesn't exist. .. method:: Paginator.get_elided_page_range(number, *, on_each_side=3, on_ends=2)