summaryrefslogtreecommitdiff
path: root/doc/unigbrk.texi
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff.email>2024-03-24 08:54:48 +0100
committerJörg Frings-Fürst <debian@jff.email>2024-03-24 08:54:48 +0100
commit163a663518f33bab48b28431972e580b366b4d49 (patch)
treef518ffabaca4a0b93f0103d617e803792d3b0b43 /doc/unigbrk.texi
parent1b3a8d5ad2ea2f099d514d9dd51ebf926a628076 (diff)
parentdd0000f7e25abe6c28d4329d324fd7fcab54094f (diff)
Merge branch 'release/debian/1.2-1'HEADdebian/1.2-1master
Diffstat (limited to 'doc/unigbrk.texi')
-rw-r--r--doc/unigbrk.texi15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/unigbrk.texi b/doc/unigbrk.texi
index e7e94d6a..16b8a608 100644
--- a/doc/unigbrk.texi
+++ b/doc/unigbrk.texi
@@ -47,8 +47,9 @@ Returns NULL if and only if @code{@var{s} == @var{end}}.
Note that these functions do not handle the case when a character
outside of the range between @var{s} and @var{end} is needed to
-determine the boundary. Use @func{_grapheme_breaks} functions for such
-cases.
+determine the boundary.
+This is the case in particular with syllables in Indic scripts or emojis.
+Use @func{_grapheme_breaks} functions for such cases.
@end deftypefun
@deftypefun void u8_grapheme_prev (const@tie{}uint8_t@tie{}*@var{s}, const@tie{}uint8_t@tie{}*@var{start})
@@ -60,8 +61,9 @@ Returns NULL if and only if @code{@var{s} == @var{start}}.
Note that these functions do not handle the case when a character
outside of the range between @var{start} and @var{s} is needed to
-determine the boundary. Use @func{_grapheme_breaks} functions for such
-cases.
+determine the boundary.
+This is the case in particular with syllables in Indic scripts or emojis.
+Use @func{_grapheme_breaks} functions for such cases.
Note also that these functions work only on well-formed Unicode strings.
@end deftypefun
@@ -151,6 +153,7 @@ described in the Unicode standard, because the standard says that they
are preferred.
Note that this function does not handle the case when three or more
-consecutive characters are needed to determine the boundary. Use
-@func{uc_grapheme_breaks} for such cases.
+consecutive characters are needed to determine the boundary.
+This is the case in particular with syllables in Indic scripts or emojis.
+Use @func{uc_grapheme_breaks} for such cases.
@end deftypefun