aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/treesitter/languagetree.lua
diff options
context:
space:
mode:
authorLW <git@llllvvuu.dev>2023-09-14 03:36:16 -0700
committerGitHub <noreply@github.com>2023-09-14 03:36:16 -0700
commit9fc321c9768d1a18893e14f46b0ebacef1be1db4 (patch)
tree8037b4d0954e0bbd5a6b8fe583346ed80438e83b /runtime/lua/vim/treesitter/languagetree.lua
parenta4743487b71b54f05063465d5f8cde8014bcb73c (diff)
downloadrneovim-9fc321c9768d1a18893e14f46b0ebacef1be1db4.tar.gz
rneovim-9fc321c9768d1a18893e14f46b0ebacef1be1db4.tar.bz2
rneovim-9fc321c9768d1a18893e14f46b0ebacef1be1db4.zip
refactor(treesitter): deprecate for_each_child #25118
The name for_each_child is misleading and caused bugs. After #25111, #25115, there are no more usages of `for_each_child` in Nvim. In the future if we want to restore this functionality we can consider a generalized vim.traverse(node, key, visitor) function.
Diffstat (limited to 'runtime/lua/vim/treesitter/languagetree.lua')
-rw-r--r--runtime/lua/vim/treesitter/languagetree.lua3
1 files changed, 3 insertions, 0 deletions
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 6037b17b20..1ea0f6b2b9 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -451,11 +451,14 @@ function LanguageTree:parse(range)
return self._trees
end
+---@deprecated Misleading name. Use `LanguageTree:children()` (non-recursive) instead,
+--- add recursion yourself if needed.
--- Invokes the callback for each |LanguageTree| and its children recursively
---
---@param fn fun(tree: LanguageTree, lang: string)
---@param include_self boolean|nil Whether to include the invoking tree in the results
function LanguageTree:for_each_child(fn, include_self)
+ vim.deprecate('LanguageTree:for_each_child()', 'LanguageTree:children()', '0.11')
if include_self then
fn(self, self._lang)
end