From: Steven G. Johnson <stevenj@alum.mit.edu>
Date: Sat, 30 Mar 2019 20:04:14 +0000 (-0400)
Subject: doc clarification (closing #110)
X-Git-Tag: archive/raspbian/2.11.3-2+rpi1^2~10^2~1^2~96
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=3637d518558553f098697e2164d721aed575a075;p=utf8proc.git

doc clarification (closing #110)
---

diff --git a/utf8proc.h b/utf8proc.h
index f5cc1e1..d12b721 100644
--- 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);