aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRiley Bruins <ribru17@hotmail.com>2024-10-25 14:09:29 -0700
committerLewis Russell <me@lewisr.dev>2024-10-27 09:25:07 +0000
commitf60a1f90599df0b773a107232f4005d6dea194b0 (patch)
treea328a4f5d73f54f4dd62e14dfacf6ae24736c7eb
parent25b53b593ef6f229fbec5b3dc205a7539579d13a (diff)
downloadrneovim-f60a1f90599df0b773a107232f4005d6dea194b0.tar.gz
rneovim-f60a1f90599df0b773a107232f4005d6dea194b0.tar.bz2
rneovim-f60a1f90599df0b773a107232f4005d6dea194b0.zip
docs(treesitter): specify predicate boolean return value
-rw-r--r--runtime/doc/treesitter.txt2
-rw-r--r--runtime/lua/vim/treesitter/query.lua2
2 files changed, 2 insertions, 2 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index f9a98250ea..e439e8fccb 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -1211,7 +1211,7 @@ add_predicate({name}, {handler}, {opts})
Parameters: ~
• {name} (`string`) Name of the predicate, without leading #
- • {handler} (`fun(match: table<integer,TSNode[]>, pattern: integer, source: integer|string, predicate: any[], metadata: vim.treesitter.query.TSMetadata)`)
+ • {handler} (`fun(match: table<integer,TSNode[]>, pattern: integer, source: integer|string, predicate: any[], metadata: vim.treesitter.query.TSMetadata): boolean?`)
• see |vim.treesitter.query.add_directive()| for argument
meanings
• {opts} (`table?`) A table with the following fields:
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 4614967799..1677e8d364 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -626,7 +626,7 @@ local directive_handlers = {
--- Adds a new predicate to be used in queries
---
---@param name string Name of the predicate, without leading #
----@param handler fun(match: table<integer,TSNode[]>, pattern: integer, source: integer|string, predicate: any[], metadata: vim.treesitter.query.TSMetadata)
+---@param handler fun(match: table<integer,TSNode[]>, pattern: integer, source: integer|string, predicate: any[], metadata: vim.treesitter.query.TSMetadata): boolean?
--- - see |vim.treesitter.query.add_directive()| for argument meanings
---@param opts? vim.treesitter.query.add_predicate.Opts
function M.add_predicate(name, handler, opts)