diff options
| author | Christian Clason <c.clason@uni-graz.at> | 2022-09-14 11:08:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-14 11:08:31 +0200 |
| commit | ddb762f4013ac2532ad45704466058d867e3a6ed (patch) | |
| tree | 2903c84de8106943a661dc193705ddf2a7c42244 /runtime/lua/vim/treesitter/language.lua | |
| parent | 8b0b0a5c32d3e913f273b9eb11e572f58f7cbd35 (diff) | |
| download | rneovim-ddb762f4013ac2532ad45704466058d867e3a6ed.tar.gz rneovim-ddb762f4013ac2532ad45704466058d867e3a6ed.tar.bz2 rneovim-ddb762f4013ac2532ad45704466058d867e3a6ed.zip | |
docs(treesitter): clean up and update treesitter.txt (#20142)
* add type annotations to code
* clean up and expand static documentation
* consistent use of tags for static and generated docs
Diffstat (limited to 'runtime/lua/vim/treesitter/language.lua')
| -rw-r--r-- | runtime/lua/vim/treesitter/language.lua | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua index d14b825603..c92d63b8c4 100644 --- a/runtime/lua/vim/treesitter/language.lua +++ b/runtime/lua/vim/treesitter/language.lua @@ -2,14 +2,15 @@ local a = vim.api local M = {} ---- Asserts that the provided language is installed, and optionally provide a path for the parser +--- Asserts that a parser for the language {lang} is installed. --- ---- Parsers are searched in the `parser` runtime directory. +--- Parsers are searched in the `parser` runtime directory, or the provided {path} --- ----@param lang string The language the parser should parse ----@param path string|nil Optional path the parser is located at ----@param silent boolean|nil Don't throw an error if language not found ----@param symbol_name string|nil Internal symbol name for the language to load +---@param lang string Language the parser should parse +---@param path (string|nil) Optional path the parser is located at +---@param silent (boolean|nil) Don't throw an error if language not found +---@param symbol_name (string|nil) Internal symbol name for the language to load +---@return boolean If the specified language is installed function M.require_language(lang, path, silent, symbol_name) if vim._ts_has_language(lang) then return true @@ -42,7 +43,8 @@ end --- --- Inspecting provides some useful information on the language like node names, ... --- ----@param lang The language. +---@param lang string Language +---@return table function M.inspect_language(lang) M.require_language(lang) return vim._ts_inspect_language(lang) |