From 29113e6892a46d4afff41417c0be7122a3b97ae6 Mon Sep 17 00:00:00 2001
From: Stephan Seitz <stephan.seitz@fau.de>
Date: Wed, 14 Jul 2021 01:08:57 +0200
Subject: [PATCH] doc: be more explicit about additional_vim_regex_highlighting
 (#1561)

---
 README.md               | 10 ++++++++++
 doc/nvim-treesitter.txt |  4 +++-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a16926cea..937c4cc01 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,11 @@ require'nvim-treesitter.configs'.setup {
   highlight = {
     enable = true,              -- false will disable the whole extension
     disable = { "c", "rust" },  -- list of language that will be disabled
+    -- Setting this to true will run `:h syntax` and tree-sitter at the same time.
+    -- Set this to `true` if you depend on 'syntax' being enabled (like for indentation).
+    -- Using this option may slow down your editor, and you may see some duplicate highlights.
+    -- Instead of true it can also be a list of languages
+    additional_vim_regex_highlighting = false,
   },
 }
 EOF
@@ -225,6 +230,11 @@ require'nvim-treesitter.configs'.setup {
       -- Highlight the @foo.bar capture group with the "Identifier" highlight group.
       ["foo.bar"] = "Identifier",
     },
+    -- Setting this to true will run `:h syntax` and tree-sitter at the same time.
+    -- Set this to `true` if you depend on 'syntax' being enabled (like for indentation).
+    -- Using this option may slow down your editor, and you may see some duplicate highlights.
+    -- Instead of true it can also be a list of languages
+    additional_vim_regex_highlighting = false,
   },
 }
 EOF
diff --git a/doc/nvim-treesitter.txt b/doc/nvim-treesitter.txt
index 68a9f15e4..120831993 100644
--- a/doc/nvim-treesitter.txt
+++ b/doc/nvim-treesitter.txt
@@ -111,7 +111,7 @@ Supported options:
 - disable: list of languages.
 - custom_captures: A map of user defined capture groups to highlight groups.
   See |nvim-treesitter-query-extensions|.
-- additional_vim_regex_highlighting: `true` or `false`, or a dictionary of languages.
+- additional_vim_regex_highlighting: `true` or `false`, or a list of languages.
   Set this to `true` if you depend on 'syntax' being enabled
   (like for indentation). Using this option may slow down your editor,
   and you may see some duplicate highlights.
@@ -126,6 +126,8 @@ Supported options:
         -- Highlight the @foo.bar capture group with the "Identifier" highlight group.
         ["foo.bar"] = "Identifier",
       },
+      -- Setting this to true or a list of languages will run `:h syntax` and tree-sitter at the same time.
+      additional_vim_regex_highlighting = false,
     },
   }
   EOF