docs(config): explain more about the delay option

utilyre · Mar 14, 2023 · f795062 · f795062
1 parent bfb79ea
commit f795062
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -95,7 +95,11 @@ outer pair.
   ---@type table<string, boolean>
   excluded_filetypes = {},
 
-  ---How much to wait before calculating the location of pairs.
+  ---How much should the cursor stay still (in milliseconds) to calculate and
+  ---render the pairs.
+  ---
+  ---NOTE: It's recommended to set this somewhere above and close to your key
+  ---repeat speed in order to keep the calculations at minimum.
   ---
   ---@type integer
   delay = 50,

diff --git a/lua/sentiment/config/default.lua b/lua/sentiment/config/default.lua
@@ -12,7 +12,11 @@ local Config = {
   ---@type table<string, boolean>
   excluded_filetypes = {},
 
-  ---How much to wait before calculating the location of pairs.
+  ---How much should the cursor stay still (in milliseconds) to calculate and
+  ---render the pairs.
+  ---
+  ---NOTE: It's recommended to set this somewhere above and close to your key
+  ---repeat speed in order to keep the calculations at minimum.
   ---
   ---@type integer
   delay = 50,