add word motion documentation

pit-ray · Jan 14, 2024 · 7581643 · 7581643
1 parent b809e4c
commit 7581643
Showing 1 changed file with 52 additions and 0 deletions.
diff --git a/docs/cheat_sheet/functions/index.md b/docs/cheat_sheet/functions/index.md
@@ -1236,6 +1236,13 @@ Move the caret to right.
 **Vim Emulation:** `w`  
 Move words forward for normal mode.
 
+It performs word-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+Instead, you can [move_fwd_word_simple](./#move_fwd_word_simple) for visual mode, which is faster and simpler (of course, it is also available for other modes)
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1258,6 +1265,13 @@ Move words forward fast.
 **Vim Emulation:** `b`  
 Move words backward for normal mode.
 
+It performs word-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+Instead, you can [move_bck_word_simple](./#move_fwd_word_simple) for visual mode, which is faster and simpler (of course, it is also available for other modes)
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1280,6 +1294,13 @@ Move words backward fast.
 **Vim Emulation:** `W`  
 Move WORDS forward.
 
+It performs WORD-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+Instead, you can [move_fwd_word_simple](./#move_fwd_word_simple) for visual mode, which is faster and simpler (of course, it is also available for other modes)
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1291,6 +1312,13 @@ Move WORDS forward.
 **Vim Emulation:** `B`  
 Move WORDS backward.
 
+It performs WORD-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+Instead, you can [move_bck_word_simple](./#move_fwd_word_simple) for visual mode, which is faster and simpler (of course, it is also available for other modes)
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1302,6 +1330,12 @@ Move WORDS backward.
 **Vim Emulation:** `e`  
 Forward to the end of words.
 
+It performs word-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1313,6 +1347,12 @@ Forward to the end of words.
 **Vim Emulation:** `E`  
 Forward to the end of WORDS.
 
+It performs WORD-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1324,6 +1364,12 @@ Forward to the end of WORDS.
 **Vim Emulation:** `ge`  
 Backward to the end of words.
 
+It performs word-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)
@@ -1335,6 +1381,12 @@ Backward to the end of words.
 **Vim Emulation:** `gE`  
 Backward to the end of WORDS.
 
+It performs WORD-motion using an algorithm that is completely identical to Vim.
+However, it is not available in visual mode, since the text is selected and copied once and retrieved via the clipboard for text parsing.
+
+The `iskeyword` option is fixed to the default value of Vim in Windows and cannot change it currently.
+There is an option [charbreak](../options/#charbreak) to set the criteria for considering a Unicode character as a single character. 
+
 <!--
 **See Also**
 - [\<a\>](./#a)