From 4d01ec19b55653cbef0d217d5ccf7d5276a8c730 Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Thu, 1 Dec 2016 21:52:11 -0500 Subject: [PATCH] Update README.md Added note about ordering field name. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1f5e775..3e55bbe 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ To add "sortability" to a model, you need to inherit `SortableMixin` and at mini - `BigIntegerField` - `Meta.ordering` **must only contain one value**, otherwise, your objects will not be sorted correctly. +- **IMPORTANT**: You must name the field you use for ordering something other than "order_field" as this name is reserved by the `SortableMixin` class. - It is recommended that you set `editable=False` and `db_index=True` on the field defined in `Meta.ordering` for a seamless Django admin experience and faster lookups on the objects. Sample Model: