docs: Add note about stable sorting to SortListModel

This commit is contained in:
Benjamin Otte 2021-10-01 00:31:51 +00:00
parent 2a3a1aaf1e
commit 5c3b368925

View File

@ -58,6 +58,13 @@
* A `GListModel` that sorts the elements of an underlying model
* according to a `GtkSorter`.
*
* The model is a stable sort. If two items compare equal according
* to the sorter, the one that appears first in the original model will
* also appear first after sorting.
* Note that if you change the sorter, the previous order will have no
* influence on the new order. If you want that, consider using a
* `GtkMultiSorter` and appending the previous sorter to it.
*
* The model can be set up to do incremental sorting, so that
* sorting long lists doesn't block the UI. See
* [method@Gtk.SortListModel.set_incremental] for details.