stringsorter: Add more detail to the docs
authorMatthias Clasen <mclasen@redhat.com>
Tue, 11 Oct 2022 18:03:57 +0000 (14:03 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 11 Oct 2022 18:09:21 +0000 (14:09 -0400)
Mention when a collation value of NONE might
be useful.

gtk/gtkstringsorter.c

index 266fc81e55f2ed12f2f628378754c9187af13dff..507adca17cf1eff165b262cc9785905638775165 100644 (file)
@@ -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] =