From 52eef14703828f4eeccbe9b02933c244ea2ab872 Mon Sep 17 00:00:00 2001 From: Yi Ming Date: Thu, 12 Sep 2024 18:41:06 +0800 Subject: [PATCH] docs(treesitter): some functions are only valid for registered parsers --- runtime/doc/treesitter.txt | 3 ++- runtime/lua/vim/treesitter/language.lua | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index fea469e63b..7545281228 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -970,7 +970,7 @@ add({lang}, {opts}) *vim.treesitter.language.add()* language to load get_filetypes({lang}) *vim.treesitter.language.get_filetypes()* - Get the filetypes associated with the parser named {lang}. + Get the filetypes associated with the registered parser named {lang}. Parameters: ~ • {lang} (`string`) Name of parser @@ -979,6 +979,7 @@ get_filetypes({lang}) *vim.treesitter.language.get_filetypes()* (`string[]`) filetypes get_lang({filetype}) *vim.treesitter.language.get_lang()* + Get the registered parser name associated with the provided filetype. Parameters: ~ • {filetype} (`string`) diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua index e31ce6cb59..d6b52303ab 100644 --- a/runtime/lua/vim/treesitter/language.lua +++ b/runtime/lua/vim/treesitter/language.lua @@ -7,7 +7,7 @@ local ft_to_lang = { help = 'vimdoc', } ---- Get the filetypes associated with the parser named {lang}. +--- Get the filetypes associated with the registered parser named {lang}. --- @param lang string Name of parser --- @return string[] filetypes function M.get_filetypes(lang) @@ -20,6 +20,7 @@ function M.get_filetypes(lang) return r end +--- Get the registered parser name associated with the provided filetype. --- @param filetype string --- @return string|nil function M.get_lang(filetype)