luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-08 10:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
There is not a total collation order defined over all Unicode
codepoints, so sometimes `g_utf8_collate()` can’t return a useful
result. Document that.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #517
This commit is contained in:
Philip Withnall 2022-01-19 12:38:37 +00:00
parent 8ec5dca0fe
commit 5483816bac
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
glib/gunicollate.c
View File

@ -71,6 +71,10 @@ msc_strxfrm_wrapper (char *string1,
* compare the keys with strcmp() when sorting instead of sorting
* 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,
* 0 if they compare equal, > 0 if @str1 compares after @str2.
**/