aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_inspector.lua
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2024-03-05 12:06:15 +0000
committerLewis Russell <me@lewisr.dev>2024-03-05 13:36:46 +0000
commita4290f462ed7dc81e17b09bd27877b106b24b6bd (patch)
treeab880e80f92fe337ff4581eba2454bb4b882375a /runtime/lua/vim/_inspector.lua
parent5b312cd5f67646005312d2ebb2ef0d1bc584dcff (diff)
downloadrneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.tar.gz
rneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.tar.bz2
rneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.zip
docs(lua): improvements for LSP and Diagnostic
Diffstat (limited to 'runtime/lua/vim/_inspector.lua')
-rw-r--r--runtime/lua/vim/_inspector.lua11
1 files changed, 7 insertions, 4 deletions
diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index a19d40c50d..2999630fce 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -1,17 +1,20 @@
--- @class vim._inspector.Filter
--- @inlinedoc
---
---- Include syntax based highlight groups (defaults to true)
+--- Include syntax based highlight groups.
+--- (default: `true`)
--- @field syntax boolean
---
---- Include treesitter based highlight groups (defaults to true)
+--- Include treesitter based highlight groups.
+--- (default: `true`)
--- @field treesitter boolean
---
--- Include extmarks. When `all`, then extmarks without a `hl_group` will also be included.
--- (default: true)
--- @field extmarks boolean|"all"
---
---- Include semantic token highlights (defaults to true)
+--- Include semantic token highlights.
+--- (default: true)
--- @field semantic_tokens boolean
local defaults = {
syntax = true,
@@ -145,7 +148,7 @@ end
---@param bufnr? integer defaults to the current buffer
---@param row? integer row to inspect, 0-based. Defaults to the row of the current cursor
---@param col? integer col to inspect, 0-based. Defaults to the col of the current cursor
----@param filter? vim._inspector.Filter (table) see |vim.inspect_pos()|
+---@param filter? vim._inspector.Filter
function vim.show_pos(bufnr, row, col, filter)
local items = vim.inspect_pos(bufnr, row, col, filter)