From 2e92065686f62851318150a315591c30b8306a4b Mon Sep 17 00:00:00 2001 From: Gregory Anders <8965202+gpanders@users.noreply.github.com> Date: Thu, 14 Sep 2023 08:23:01 -0500 Subject: docs: replace
with ``` (#25136)
---
runtime/lua/vim/keymap.lua | 39 +++++++++++++++++++++------------------
1 file changed, 21 insertions(+), 18 deletions(-)
(limited to 'runtime/lua/vim/keymap.lua')
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 2b55ddc787..df593be097 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -2,20 +2,21 @@ local keymap = {}
--- Adds a new |mapping|.
--- Examples:
---- lua
---- -- Map to a Lua function:
---- vim.keymap.set('n', 'lhs', function() print("real lua function") end)
---- -- Map to multiple modes:
---- vim.keymap.set({'n', 'v'}, 'lr', vim.lsp.buf.references, { buffer = true })
---- -- Buffer-local mapping:
---- vim.keymap.set('n', 'w', "w", { silent = true, buffer = 5 })
---- -- Expr mapping:
---- vim.keymap.set('i', '', function()
---- return vim.fn.pumvisible() == 1 and "" or ""
---- end, { expr = true })
---- -- mapping:
---- vim.keymap.set('n', '[%%', '(MatchitNormalMultiBackward)')
----
+---
+--- ```lua
+--- -- Map to a Lua function:
+--- vim.keymap.set('n', 'lhs', function() print("real lua function") end)
+--- -- Map to multiple modes:
+--- vim.keymap.set({'n', 'v'}, 'lr', vim.lsp.buf.references, { buffer = true })
+--- -- Buffer-local mapping:
+--- vim.keymap.set('n', 'w', "w", { silent = true, buffer = 5 })
+--- -- Expr mapping:
+--- vim.keymap.set('i', '', function()
+--- return vim.fn.pumvisible() == 1 and "" or ""
+--- end, { expr = true })
+--- -- mapping:
+--- vim.keymap.set('n', '[%%', '(MatchitNormalMultiBackward)')
+--- ```
---
---@param mode string|table Mode short-name, see |nvim_set_keymap()|.
--- Can also be list of modes to create mapping on multiple modes.
@@ -80,11 +81,13 @@ end
--- Remove an existing mapping.
--- Examples:
---- lua
---- vim.keymap.del('n', 'lhs')
---
---- vim.keymap.del({'n', 'i', 'v'}, 'w', { buffer = 5 })
----
+--- ```lua
+--- vim.keymap.del('n', 'lhs')
+---
+--- vim.keymap.del({'n', 'i', 'v'}, 'w', { buffer = 5 })
+--- ```
+---
---@param opts table|nil A table of optional arguments:
--- - "buffer": (number|boolean) Remove a mapping from the given buffer.
--- When `0` or `true`, use the current buffer.
--
cgit