diff options
| author | Yi Ming <ofseed@foxmail.com> | 2024-03-02 14:29:41 +0000 |
|---|---|---|
| committer | Christian Clason <c.clason@uni-graz.at> | 2024-03-06 14:21:46 +0100 |
| commit | 3c572a31a3bb7009b4ad8eac56da1458acae3b75 (patch) | |
| tree | 956cd001ccc0fd11dd74712f5d5d07580df972e8 | |
| parent | 3e016fa8d4f797345d55f6006c42026abedb6c4e (diff) | |
| download | rneovim-3c572a31a3bb7009b4ad8eac56da1458acae3b75.tar.gz rneovim-3c572a31a3bb7009b4ad8eac56da1458acae3b75.tar.bz2 rneovim-3c572a31a3bb7009b4ad8eac56da1458acae3b75.zip | |
docs(treesitter): fix ambiguous parameter description about `lang`
| -rw-r--r-- | runtime/doc/treesitter.txt | 7 | ||||
| -rw-r--r-- | runtime/lua/vim/treesitter.lua | 8 |
2 files changed, 8 insertions, 7 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 1d9b67adec..7e2559ecd6 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -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 diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua index 61c5d66958..7cfebd2c00 100644 --- a/runtime/lua/vim/treesitter.lua +++ b/runtime/lua/vim/treesitter.lua @@ -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, |