From f9c61e8090b37acf79032fc6a84439a35485bdf2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 22 Jul 2015 12:36:32 +0100 Subject: [PATCH] Prominent notes on deprecation status of pagination settings. Closes #3173. --- docs/api-guide/settings.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 6fdb77c86..13d23a69e 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -119,6 +119,14 @@ Default: `None` #### PAGINATE_BY_PARAM +--- + +**This setting is pending deprecation.** + +See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style). + +--- + The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If set to `None`, clients may not override the default page size. For example, given the following settings: @@ -136,6 +144,14 @@ Default: `None` #### MAX_PAGINATE_BY +--- + +**This setting is pending deprecation.** + +See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style). + +--- + The maximum page size to allow when the page size is specified by the client. If set to `None`, then no maximum limit is applied. For example, given the following settings: