fix: Update docs

folke · May 14, 2021 · 2273076 · 2273076
1 parent 7a00efb
commit 2273076
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -99,9 +99,10 @@ Todo comes with the following defaults:
   },
   -- regex that will be used to match keywords.
   -- don't replace the (KEYWORDS) placeholder
-  pattern = "(KEYWORDS):",
-  -- pattern = "(KEYWORDS)", -- match without the extra colon. You'll likely get false positives
-  -- pattern = "-- (KEYWORDS):", -- only match in lua comments
+  rg_pattern = '\\b(KEYWORDS):', -- rust regex
+  hl_pattern = '<(KEYWORDS)>:', -- viml regex, this substitudes %s inside commentstring option
+  -- rg_pattern = "(KEYWORDS)", -- match without the extra colon. You'll likely get false positives
+  -- rg_pattern = "-- (KEYWORDS):", -- only match in lua comments
 }
 ```
 

diff --git a/lua/todo-comments/config.lua b/lua/todo-comments/config.lua
@@ -50,8 +50,8 @@ local defaults = {
   -- don't replace the (KEYWORDS) placeholder
   rg_pattern = '\\b(KEYWORDS):', -- rust regex
   hl_pattern = '<(KEYWORDS)>:', -- viml regex, this substitudes %s inside commentstring option
-  -- pattern = "(KEYWORDS)", -- match without the extra colon. You'll likely get false positives
-  -- pattern = "-- (KEYWORDS):", -- only match in lua comments
+  -- rg_pattern = "(KEYWORDS)", -- match without the extra colon. You'll likely get false positives
+  -- rg_pattern = "-- (KEYWORDS):", -- only match in lua comments
 }
 
 M._options = nil