mirror of
https://github.com/ksyasuda/dotfiles.git
synced 2025-12-08 10:48:01 -08:00
update docstrings
This commit is contained in:
@@ -2,6 +2,13 @@ local M = {}
|
||||
local map = vim.keymap.set
|
||||
local opts = { noremap = true, silent = true }
|
||||
|
||||
--- Set keybindings from a table of mappings.
|
||||
--- @param bindings table A list of keybinding mappings.
|
||||
--- Each mapping should be a table with the following keys:
|
||||
--- - mode: string, the mode in which the keybinding applies (e.g., 'n', 'i', 'v').
|
||||
--- - key: string, the key to bind.
|
||||
--- - cmd: string, the command to execute when the key is pressed.
|
||||
--- - opts: table, optional, additional options for the keybinding (default:
|
||||
function M.set_keybindings(bindings)
|
||||
for _, binding in ipairs(bindings) do
|
||||
map(binding.mode, binding.key, binding.cmd, binding.opts or opts)
|
||||
|
||||
@@ -4,8 +4,8 @@ local whichkey = require("which-key")
|
||||
vim.notify = require("notify")
|
||||
|
||||
---Helper function to add mappings to which-key
|
||||
---@parm mappings table : List of mappings to add to which-key
|
||||
---@parm group table : Group to add mappings to (optional)
|
||||
---@param mappings table List of mappings to add
|
||||
---@param group table Group to add mappings to (optional)
|
||||
---@return nil
|
||||
---@usage addToWhichKey(mappings, group)
|
||||
---@example addToWhichKey({{key = "n", cmd = "next", mode = "n", desc = "Next Line", group = "Navigation"}, {key = "t", group = "example"})
|
||||
|
||||
Reference in New Issue
Block a user