From 5e96a1ddf17946595a22083b035f99418dd2cbd7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 23 Mar 2015 11:34:01 +0000 Subject: Update documentation --- api-guide/pagination/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'api-guide/pagination/index.html') diff --git a/api-guide/pagination/index.html b/api-guide/pagination/index.html index 6da6e135..b51d7610 100644 --- a/api-guide/pagination/index.html +++ b/api-guide/pagination/index.html @@ -589,7 +589,7 @@ class StandardResultsSetPagination(PageNumberPagination):
The CursorPagination class includes a number of attributes that may be overridden to modify the pagination style.
To set these attributes you should override the CursorPagination class, and then enable your custom pagination class as above.
page_size = A numeric value indicating the page size. If set, this overrides the DEFAULT_PAGE_SIZE setting. Defaults to the same value as the DEFAULT_PAGE_SIZE settings key.page_size = A numeric value indicating the page size. If set, this overrides the PAGE_SIZE setting. Defaults to the same value as the PAGE_SIZE settings key.cursor_query_param = A string value indicating the name of the "cursor" query parameter. Defaults to 'cursor'.ordering = This should be a string, or list of strings, indicating the field against which the cursor based pagination will be applied. For example: ordering = 'slug'. Defaults to -created. This value may also be overridden by using OrderingFilter on the view.template = The name of a template to use when rendering pagination controls in the browsable API. May be overridden to modify the rendering style, or set to None to disable HTML pagination controls completely. Defaults to "rest_framework/pagination/previous_and_next.html".