Skip to content

Commit

Permalink
Improved pagination documentation
Browse files Browse the repository at this point in the history
* Link to the topic guide
* Document that page() can raise PageNotAnInteger.
  • Loading branch information
adamchainz authored and carltongibson committed Feb 11, 2021
1 parent a2fa2fa commit a57e91a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/ref/paginator.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 </topics/pagination>`.

.. module:: django.core.paginator
:synopsis: Classes to help you easily manage paginated data.

Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit a57e91a

Please sign in to comment.