diff options
| author | Adam Johnson <me@adamj.eu> | 2021-02-08 23:38:55 +0000 |
|---|---|---|
| committer | Carlton Gibson <carlton@noumenal.es> | 2021-02-11 14:17:01 +0100 |
| commit | a57e91adeeef4fe97db3e589b20bf2a30c907e21 (patch) | |
| tree | e138cefea9a4490905394ef5e434b769056906b6 /docs | |
| parent | a2fa2fa2f840350d23698df78bae5677c20cb623 (diff) | |
Improved pagination documentation
* Link to the topic guide
* Document that page() can raise PageNotAnInteger.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/paginator.txt | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/ref/paginator.txt b/docs/ref/paginator.txt index 7758234d6e..e6d67755d0 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 </topics/pagination>`. + .. 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) |
