Skip to content

Commit ebb257e

Browse files
committed
Fix feincms#23: Document the fact that order_by() doesn't work as expected
1 parent fc0e9e2 commit ebb257e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,11 @@ Usage
5757
- Call the ``with_tree_fields()`` queryset method if you require the
5858
additional fields respectively the CTE.
5959
- Call the ``order_siblings_by("field_name")`` queryset method if you want to
60-
order tree siblings by a specific model field.
60+
order tree siblings by a specific model field. Note that Django's standard
61+
``order_by()`` method isn't supported -- nodes are returned according to the
62+
`depth-first search algorithm
63+
<https://en.wikipedia.org/wiki/Depth-first_search>`__. It's not possible to
64+
order siblings by more than one field either.
6165
- Create a manager using
6266
``TreeQuerySet.as_manager(with_tree_fields=True)`` if you want to add
6367
tree fields to queries by default.

0 commit comments

Comments
 (0)