1 files changed, 2 insertions, 1 deletions
@@ -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);