GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 01:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(treesitter): fix ambiguous parameter description about lang

Browse Source
This commit is contained in:
Yi Ming
2024-03-02 14:29:41 +00:00
committed by Christian Clason
parent 3e016fa8d4
commit 3c572a31a3
2 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
runtime/doc/treesitter.txt
View File

@ -782,7 +782,7 @@ get_parser({bufnr}, {lang}, {opts}) *vim.treesitter.get_parser()*
Parameters: ~
• {bufnr} (`integer?`) Buffer the parser should be tied to (default:
current buffer)
• {lang} (`string?`) Filetype of this parser (default: buffer
• {lang} (`string?`) Language of this parser (default: from buffer
filetype)
• {opts} (`table?`) Options to pass to the created language tree
@ -829,7 +829,7 @@ inspect_tree({opts}) *vim.treesitter.inspect_tree()*
• {opts} (`table?`) Optional options table with the following possible
keys:
• lang (string|nil): The language of the source buffer. If
omitted, the filetype of the source buffer is used.
omitted, detect from the filetype of the source buffer.
• bufnr (integer|nil): Buffer to draw the tree into. If
omitted, a new buffer is created.
• winid (integer|nil): Window id to display the tree buffer
@ -895,7 +895,8 @@ start({bufnr}, {lang}) *vim.treesitter.start()*
Parameters: ~
• {bufnr} (`integer?`) Buffer to be highlighted (default: current
buffer)
• {lang} (`string?`) Language of the parser (default: buffer filetype)
• {lang} (`string?`) Language of the parser (default: from buffer
filetype)
stop({bufnr}) *vim.treesitter.stop()*
Stops treesitter highlighting for a buffer

8
runtime/lua/vim/treesitter.lua
View File

@ -77,7 +77,7 @@ end
--- If needed, this will create the parser.
---
---@param bufnr (integer|nil) Buffer the parser should be tied to (default: current buffer)
---@param lang (string|nil) Filetype of this parser (default: buffer filetype)
---@param lang (string|nil) Language of this parser (default: from buffer filetype)
---@param opts (table|nil) Options to pass to the created language tree
---
---@return vim.treesitter.LanguageTree object to use for parsing
@ -452,7 +452,7 @@ end
--- ```
---
---@param bufnr (integer|nil) Buffer to be highlighted (default: current buffer)
---@param lang (string|nil) Language of the parser (default: buffer filetype)
---@param lang (string|nil) Language of the parser (default: from buffer filetype)
function M.start(bufnr, lang)
bufnr = bufnr or api.nvim_get_current_buf()
local parser = M.get_parser(bufnr, lang)
@ -480,8 +480,8 @@ end
--- Can also be shown with `:InspectTree`. *:InspectTree*
---
---@param opts table|nil Optional options table with the following possible keys:
--- - lang (string|nil): The language of the source buffer. If omitted, the
--- filetype of the source buffer is used.
--- - lang (string|nil): The language of the source buffer. If omitted, detect
--- from the filetype of the source buffer.
--- - bufnr (integer|nil): Buffer to draw the tree into. If omitted, a new
--- buffer is created.
--- - winid (integer|nil): Window id to display the tree buffer in. If omitted,