aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2015-03-09 08:48:03 +0000
committerTom Christie2015-03-09 08:48:03 +0000
commitdfd6a1f0fb215933ce255445732e2bca64710fd7 (patch)
tree11e11ddb7c1ae85b2200cb5631909e2b5c5b41c1
parent53e1a2fcb9643a4a1ea07881ea207e9bbefdf5df (diff)
parent20ba47e3430a1ae18d47aee7c9e55b43db43c61b (diff)
downloaddjango-rest-framework-dfd6a1f0fb215933ce255445732e2bca64710fd7.tar.bz2
Merge pull request #2658 from ddx/cursorpagination-docs-typo
Fixed missing word in CursorPagination docs
-rw-r--r--docs/api-guide/pagination.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/api-guide/pagination.md b/docs/api-guide/pagination.md
index bc65267f..4f97e7ea 100644
--- a/docs/api-guide/pagination.md
+++ b/docs/api-guide/pagination.md
@@ -164,7 +164,7 @@ Cursor based pagination is more complex than other schemes. It also requires tha
#### Details and limitations
-Proper use of cursor based pagination a little attention to detail. You'll need to think about what ordering you want the scheme to be applied against. The default is to order by `"-created"`. This assumes that **there must be a 'created' timestamp field** on the model instances, and will present a "timeline" style paginated view, with the most recently added items first.
+Proper use of cursor based pagination requires a little attention to detail. You'll need to think about what ordering you want the scheme to be applied against. The default is to order by `"-created"`. This assumes that **there must be a 'created' timestamp field** on the model instances, and will present a "timeline" style paginated view, with the most recently added items first.
You can modify the ordering by overriding the `'ordering'` attribute on the pagination class, or by using the `OrderingFilter` filter class together with `CursorPagination`. When used with `OrderingFilter` you should strongly consider restricting the fields that the user may order by.
@@ -314,4 +314,4 @@ The [`DRF-extensions` package][drf-extensions] includes a [`PaginateByMaxMixin`
[link-header]: ../img/link-header-pagination.png
[drf-extensions]: http://chibisov.github.io/drf-extensions/docs/
[paginate-by-max-mixin]: http://chibisov.github.io/drf-extensions/docs/#paginatebymaxmixin
-[disqus-cursor-api]: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/ \ No newline at end of file
+[disqus-cursor-api]: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/