search

kylechui / nvim-surround

Add/change/delete surrounding delimiter pairs with ease. Written with :heart: in Lua.
MIT License
3.18k stars 62 forks source link

Add description to keymaps #96

Closed baodrate closed 2 years ago

baodrate commented 2 years ago

Add desc to the vim.keymap.set opts. Currently they show up as (e.g.) @<Lua function 40> when calling :nmap and y -> in Which Key, which isn't very friendly.

kylechui commented 2 years ago

This is a very good idea, but I'm currently working on branch add-more-keymaps, which would essentially nullify this PR. Please wait a few more days while I get that sorted out, and then open up another PR. P.S. In the future please use add instead of insert, as there's going to be a breaking change where insert refers to insert mode mappings, and add refers to the action of "adding a new surrounding pair", whether it be in insert/normal/visual modes. Thanks!

kylechui commented 2 years ago

@qubidt If you would like to, you can make another PR to main to "get credit" and show up on the contributors page. If you don't really care, then I can make the commit myself.

baodrate commented 2 years ago

No worries about credit, it's probably better if you write the descriptions anyways since I'm pretty new to (nvim-)surround so I'm not that familiar with some of these behaviors

kylechui commented 2 years ago

Sounds good, I appreciate the contribution nonetheless :sparkling_heart:

kylechui commented 2 years ago

@qubidt Keymap descriptions have been added in the latest commit.