stringsorter: Add more detail to the docs

Mention when a collation value of NONE might be useful.
2022-10-11 14:03:57 -04:00
parent 2520148ebb
commit 05323869d7
1 changed files with 6 additions and 0 deletions
--- a/gtk/gtkstringsorter.c
+++ b/gtk/gtkstringsorter.c
@@ -335,6 +335,12 @@ gtk_string_sorter_class_init (GtkStringSorterClass *class)
   *
   * The collation method to use for sorting.
   *
+   * The `GTK_COLLATION_NONE` value is useful when the expression already
+   * returns collation keys, or strings that need to be compared byte-by-byte.
+   *
+   * The default value, `GTK_COLLATION_UNICODE`, compares strings according
+   * to the [Unicode collation algorithm](https://www.unicode.org/reports/tr10/).
+   *
   * Since: 4.10
   */
  properties[PROP_COLLATION] =