summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2021-12-16 14:13:17 +0100
committerBruno Haible <bruno@clisp.org>2021-12-16 14:14:01 +0100
commit5c0e331cdde253593f31c14adbc26af3d9b256f0 (patch)
treec967dcbf64d0991681bc1ff10860b7753d316446 /doc
parent276c406870573ba9ac0318d16761fd3058ab11a8 (diff)
downloadlibunistring-5c0e331cdde253593f31c14adbc26af3d9b256f0.tar.gz
doc: Clarify u{8,16,32}_grapheme_prev behaviour.
Reported by Vincent Westenberg <vincent.westenberg@posteo.de> in <https://lists.gnu.org/archive/html/bug-libunistring/2021-12/msg00001.html>. * doc/unigbrk.texi (Grapheme cluster breaks in a string): Clarify that the u{8,16,32}_grapheme_prev functions, like u{8,16,32}_prev, work only on well-formed Unicode strings.
Diffstat (limited to 'doc')
-rw-r--r--doc/unigbrk.texi2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/unigbrk.texi b/doc/unigbrk.texi
index af4d996..e7e94d6 100644
--- a/doc/unigbrk.texi
+++ b/doc/unigbrk.texi
@@ -62,6 +62,8 @@ 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.
+
+Note also that these functions work only on well-formed Unicode strings.
@end deftypefun
The following functions determine all of the grapheme cluster