[gspell] CurrentWordPolicy: better document text_deleted()

[Sébastien Wilmet <swilmet src gnome org>]

commit 22a58fbf2c68a6e48b9c2e7fc934e500165ee255
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed Dec 21 16:53:30 2016 +0100

    CurrentWordPolicy: better document text_deleted()

 gspell/gspell-current-word-policy.c |   11 +++++++++--
 1 files changed, 9 insertions(+), 2 deletions(-)
---
diff --git a/gspell/gspell-current-word-policy.c b/gspell/gspell-current-word-policy.c
index beb86d6..3884539 100644
--- a/gspell/gspell-current-word-policy.c
+++ b/gspell/gspell-current-word-policy.c
@@ -182,8 +182,15 @@ _gspell_current_word_policy_single_char_inserted (GspellCurrentWordPolicy *polic
        }
 }
 
-/* Before a text deletion. "start" refers to the start of the deletion. "end"
- * refers to the end of the deletion.
+/* Before a text deletion.
+ *
+ * "start" refers to the start of the deletion.
+ * "end" refers to the end of the deletion.
+ * It is assumed that start < end.
+ *
+ * "inside word" and "ends word" have the same semantics as
+ * gtk_text_iter_inside_word() and gtk_text_iter_ends_word(), but custom word
+ * boundaries can be used.
  */
 void
 _gspell_current_word_policy_text_deleted (GspellCurrentWordPolicy *policy,