aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2022-09-06 17:33:44 +0200
committerChristian Clason <c.clason@uni-graz.at>2022-09-06 17:33:44 +0200
commitd01cadd82fc74baf7d292c5cbbcf223e0aa2c097 (patch)
treecc9bf51c07dc45a6a174ea037a8f97141dc91f7f /runtime/doc
parent6e3a69b4cf5c526443b96cf857847d6c3b0586d8 (diff)
downloadrneovim-d01cadd82fc74baf7d292c5cbbcf223e0aa2c097.tar.gz
rneovim-d01cadd82fc74baf7d292c5cbbcf223e0aa2c097.tar.bz2
rneovim-d01cadd82fc74baf7d292c5cbbcf223e0aa2c097.zip
fix(treesitter): don't support legacy syntax in start()
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/treesitter.txt10
1 files changed, 4 insertions, 6 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index 8d5e494601..dbc81dbd96 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -446,20 +446,21 @@ node_contains({node}, {range}) *node_contains()*
Return: ~
(boolean) True if the node contains the range
-start({bufnr}, {lang}, {opts}) *start()*
+start({bufnr}, {lang}) *start()*
Start treesitter highlighting for a buffer
Can be used in an ftplugin or FileType autocommand
Note: By default, disables regex syntax highlighting, which may be
- required for some plugins. In this case, add `{ syntax = true }`.
+ required for some plugins. In this case, add vim.bo.syntax = 'on `after the call to` start`.
Example:
>
vim.api.nvim_create_autocmd( 'FileType', { pattern = 'tex',
callback = function(args)
- vim.treesitter.start(args.buf, 'latex', { syntax = true })
+ vim.treesitter.start(args.buf, 'latex')
+ vim.bo[args.buf].syntax = 'on' -- only if additional legacy syntax is needed
end
})
<
@@ -469,9 +470,6 @@ start({bufnr}, {lang}, {opts}) *start()*
buffer)
{lang} (string|nil) Language of the parser (default: buffer
filetype)
- {opts} (table|nil) Optional keyword arguments:
- • `syntax` boolean Run regex syntax highlighting (default
- false)
stop({bufnr}) *stop()*
Stop treesitter highlighting for a buffer