docs(README.md): Add description to keymap (#3276)

* Add human readable description to keymap * Update README.md Co-authored-by: James Trew <[email protected]> --------- Co-authored-by: James Trew <[email protected]>
nvim-telescope · Sep 18, 2024 · 0df05c9 · 0df05c9
1 parent 40d6d81
commit 0df05c9
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -158,10 +158,10 @@ Using Lua:
 
 ```lua
 local builtin = require('telescope.builtin')
-vim.keymap.set('n', '<leader>ff', builtin.find_files, {})
-vim.keymap.set('n', '<leader>fg', builtin.live_grep, {})
-vim.keymap.set('n', '<leader>fb', builtin.buffers, {})
-vim.keymap.set('n', '<leader>fh', builtin.help_tags, {})
+vim.keymap.set('n', '<leader>ff', builtin.find_files, { desc = 'Telescope find files' })
+vim.keymap.set('n', '<leader>fg', builtin.live_grep, { desc = 'Telescope live grep' })
+vim.keymap.set('n', '<leader>fb', builtin.buffers, { desc = 'Telescope buffers' })
+vim.keymap.set('n', '<leader>fh', builtin.help_tags, { desc = 'Telescope help tags' })
 ```
 
 See [builtin pickers](#pickers) for a list of all builtin functions.