From 2273076591b9ce78f562b52e3c0b4e34102f54a5 Mon Sep 17 00:00:00 2001 From: Mike Date: Fri, 14 May 2021 11:03:54 -0500 Subject: [PATCH] fix: Update docs --- README.md | 7 ++++--- lua/todo-comments/config.lua | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 02f02c8..51b277f 100644 --- 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 index 1ef880d..cb9f6d3 100644 --- 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