Feat request: Add keymap descriptions

[rafamadriz]

Giving a description to keymaps would integrate nicely with other plugins like for example which-key.nvim, other benefit is that you can know what exactly a keymap is for when using something like verbose.

With descriptions:

Without descriptions:

As a reference, this was added to kylechui/nvim-surround
in this commit kylechui/nvim-surround@306a928

[numToStr]

Sure. This will be a nice addition. PR also welcome :)

[rafamadriz]

Of course, I'd love to do a PR. Can I get some guidance ? If I understand correctly, I need to work on these two place:

Comment.nvim/lua/Comment/api.lua

Lines 238 to 293 in 2e0572c

	function api.setup(config)
	local cfg = Config:set(config):get()
	if cfg.mappings then
	local K = vim.keymap.set
	-- Basic Mappings
	if cfg.mappings.basic then
	-- NORMAL mode mappings
	K(
	'n',
	cfg.toggler.line,
	"v:count == 0 ? '<Plug>(comment_toggle_current_linewise)' : '<Plug>(comment_toggle_linewise_count)'",
	{ expr = true, remap = true }
	)
	K(
	'n',
	cfg.toggler.block,
	"v:count == 0 ? '<Plug>(comment_toggle_current_blockwise)' : '<Plug>(comment_toggle_blockwise_count)'",
	{ expr = true, remap = true }
	)
	K('n', cfg.opleader.line, '<Plug>(comment_toggle_linewise)')
	K('n', cfg.opleader.block, '<Plug>(comment_toggle_blockwise)')
	-- VISUAL mode mappings
	K('x', cfg.opleader.line, '<Plug>(comment_toggle_linewise_visual)')
	K('x', cfg.opleader.block, '<Plug>(comment_toggle_blockwise_visual)')
	end
	-- Extra Mappings
	if cfg.mappings.extra then
	K('n', cfg.extra.below, '<CMD>lua require("Comment.api").locked.insert_linewise_below()<CR>')
	K('n', cfg.extra.above, '<CMD>lua require("Comment.api").locked.insert_linewise_above()<CR>')
	K('n', cfg.extra.eol, '<CMD>lua require("Comment.api").locked.insert_linewise_eol()<CR>')
	end
	-- Extended Mappings
	if cfg.mappings.extended then
	-- NORMAL mode extended
	K('n', 'g>', '<CMD>lua require("Comment.api").call("comment_linewise_op")<CR>g@')
	K('n', 'g>c', '<CMD>lua require("Comment.api").call("comment_current_linewise_op")<CR>g@$')
	K('n', 'g>b', '<CMD>lua require("Comment.api").call("comment_current_blockwise_op")<CR>g@$')
	K('n', 'g<', '<CMD>lua require("Comment.api").call("uncomment_linewise_op")<CR>g@')
	K('n', 'g<c', '<CMD>lua require("Comment.api").call("uncomment_current_linewise_op")<CR>g@$')
	K('n', 'g<b', '<CMD>lua require("Comment.api").call("uncomment_current_blockwise_op")<CR>g@$')
	-- VISUAL mode extended
	K('x', 'g>', '<ESC><CMD>lua require("Comment.api").locked.comment_linewise_op(vim.fn.visualmode())<CR>')
	K('x', 'g<', '<ESC><CMD>lua require("Comment.api").locked.uncomment_linewise_op(vim.fn.visualmode())<CR>')
	end
	end
	return cfg
	end

https://github.com/numToStr/Comment.nvim/blob/ef3e6bfa41073a73c298ae90d2796f8ceda71c6a/after/plugin/Comment.lua

[numToStr]

Yes, these 2 places should work.