From 2b31f65445df9093ba007ca5a5ae6a71b899d491 Mon Sep 17 00:00:00 2001
From: WJH <hou32hou@gmail.com>
Date: Fri, 13 Oct 2023 05:06:38 +0800
Subject: [PATCH] doc(inline/iter_strings_lossy): describe different behaviors
 (#52)

---
 src/text/inline.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/text/inline.rs b/src/text/inline.rs
index c9f0f7f..0b252ac 100644
--- a/src/text/inline.rs
+++ b/src/text/inline.rs
@@ -147,6 +147,12 @@ impl<'s, T: DiffableStr + ?Sized> InlineChange<'s, T> {
     ///
     /// Each item is a tuple in the form `(emphasized, value)` where `emphasized`
     /// is true if it should be highlighted as an inline diff.
+    ///
+    /// By default, words are split by whitespace, which results in coarser diff.
+    /// For example: `"f(x) y"` is tokenized as `["f(x)", "y"]`.
+    ///
+    /// If you want it to be tokenized instead as `["f(", "x", ")"]`,
+    /// you should enable the `"unicode"` flag.
     pub fn iter_strings_lossy(&self) -> impl Iterator<Item = (bool, Cow<'_, str>)> {
         self.values()
             .iter()