docs(README.md): Add human readable description to keymap #3276
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In the readme, I think it would be nice to add human readable descriptions to the keymaps.
See: https://neovim.io/doc/user/lua.html#vim.keymap.set()
and documentation for the
desc
parameter:https://neovim.io/doc/user/api.html#nvim_set_keymap()
This makes the output for tools like which-key.nvim look nicer.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Configuration:
Checklist: