utf8proc

commit 3637d518558553f098697e2164d721aed575a075
parent e76cebb784028d33e3bfd9fd0170e6835b9522b8
Author: Steven G. Johnson <stevenj@alum.mit.edu>
Date:   Sat, 30 Mar 2019 16:04:14 -0400

doc clarification (closing #110)

Diffstat:
M
utf8proc.h
 | 
3
++-

1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/utf8proc.h b/utf8proc.h
@@ -595,7 +595,8 @@ UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_reencode(utf8proc_int32_t *buffer, 
  *              matching the rules in Unicode 8.0.0.
  *
  * @warning If the state parameter is used, `utf8proc_grapheme_break_stateful` must
- *          be called IN ORDER on ALL potential breaks in a string.
+ *          be called IN ORDER on ALL potential breaks in a string.  However, it
+ *          is safe to reset the state to zero after a grapheme break.
  */
 UTF8PROC_DLLEXPORT utf8proc_bool utf8proc_grapheme_break_stateful(
     utf8proc_int32_t codepoint1, utf8proc_int32_t codepoint2, utf8proc_int32_t *state);