Merge branch '517-collation-docs' into 'main'

gunicollate: Document that g_utf8_collate() can’t compare everything

Closes #517

See merge request GNOME/glib!2443
This commit is contained in:
Sebastian Dröge 2022-03-03 14:53:58 +00:00
commit c3735c1bc6

View File

@ -71,6 +71,10 @@ msc_strxfrm_wrapper (char *string1,
* compare the keys with strcmp() when sorting instead of sorting * compare the keys with strcmp() when sorting instead of sorting
* the original strings. * the original strings.
* *
* If the two strings are not comparable due to being in different collation
* sequences, the result is undefined. This can happen if the strings are in
* different language scripts, for example.
*
* Returns: < 0 if @str1 compares before @str2, * Returns: < 0 if @str1 compares before @str2,
* 0 if they compare equal, > 0 if @str1 compares after @str2. * 0 if they compare equal, > 0 if @str1 compares after @str2.
**/ **/