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

* Add human readable description to keymap

* Update README.md

Co-authored-by: James Trew <66286082+jamestrew@users.noreply.github.com>

---------

Co-authored-by: James Trew <66286082+jamestrew@users.noreply.github.com>
This commit is contained in:
Craig Rodrigues
2024-09-17 19:18:15 -07:00
committed by GitHub
parent 40d6d81b1d
commit 0df05c9e9f

View File

@@ -158,10 +158,10 @@ Using Lua:
```lua ```lua
local builtin = require('telescope.builtin') local builtin = require('telescope.builtin')
vim.keymap.set('n', '<leader>ff', builtin.find_files, {}) vim.keymap.set('n', '<leader>ff', builtin.find_files, { desc = 'Telescope find files' })
vim.keymap.set('n', '<leader>fg', builtin.live_grep, {}) vim.keymap.set('n', '<leader>fg', builtin.live_grep, { desc = 'Telescope live grep' })
vim.keymap.set('n', '<leader>fb', builtin.buffers, {}) vim.keymap.set('n', '<leader>fb', builtin.buffers, { desc = 'Telescope buffers' })
vim.keymap.set('n', '<leader>fh', builtin.help_tags, {}) vim.keymap.set('n', '<leader>fh', builtin.help_tags, { desc = 'Telescope help tags' })
``` ```
See [builtin pickers](#pickers) for a list of all builtin functions. See [builtin pickers](#pickers) for a list of all builtin functions.