aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_inspector.lua
diff options
context:
space:
mode:
authorC.D. MacEachern <craig.daniel.maceachern@gmail.com>2024-12-01 16:58:28 -0500
committerGitHub <noreply@github.com>2024-12-01 13:58:28 -0800
commitfeb62d5429680278c1353c565db6bb3ecb3b7c24 (patch)
tree4d5b8e21eab04a6ace5090590981ae15357d8a0f /runtime/lua/vim/_inspector.lua
parentab9cfc4dc3422af5235759efef456d3e02745217 (diff)
downloadrneovim-feb62d5429680278c1353c565db6bb3ecb3b7c24.tar.gz
rneovim-feb62d5429680278c1353c565db6bb3ecb3b7c24.tar.bz2
rneovim-feb62d5429680278c1353c565db6bb3ecb3b7c24.zip
docs: example keybind for :Inspect #31391
Diffstat (limited to 'runtime/lua/vim/_inspector.lua')
-rw-r--r--runtime/lua/vim/_inspector.lua7
1 files changed, 7 insertions, 0 deletions
diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index fccf4b8dbe..f4e41a31e5 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -146,6 +146,13 @@ end
---
---Can also be shown with `:Inspect`. [:Inspect]()
---
+---Example: To bind this function to the vim-scriptease
+---inspired `zS` in Normal mode:
+---
+---```lua
+---vim.keymap.set('n', 'zS', vim.show_pos)
+---```
+---
---@since 11
---@param bufnr? integer defaults to the current buffer
---@param row? integer row to inspect, 0-based. Defaults to the row of the current cursor