Improve docstring wording

Textualize · Nov 7, 2023 · f82b464 · f82b464
1 parent 55972a9
commit f82b464
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/rich/_wrap.py b/rich/_wrap.py
@@ -10,7 +10,10 @@
 
 
 def words(text: str) -> Iterable[tuple[int, int, str]]:
-    """Yields each word from the text as a tuple containing (start_index, end_index, word)."""
+    """Yields each word from the text as a tuple
+    containing (start_index, end_index, word). A "word" in this context may
+    include the actual word and any whitespace to the right.
+    """
     position = 0
     word_match = re_word.match(text, position)
     while word_match is not None: