Skip to content

Commit 0df05c9

Browse files
rodrigcjamestrew
andauthored
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]>
1 parent 40d6d81 commit 0df05c9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,10 @@ Using Lua:
158158

159159
```lua
160160
local builtin = require('telescope.builtin')
161-
vim.keymap.set('n', '<leader>ff', builtin.find_files, {})
162-
vim.keymap.set('n', '<leader>fg', builtin.live_grep, {})
163-
vim.keymap.set('n', '<leader>fb', builtin.buffers, {})
164-
vim.keymap.set('n', '<leader>fh', builtin.help_tags, {})
161+
vim.keymap.set('n', '<leader>ff', builtin.find_files, { desc = 'Telescope find files' })
162+
vim.keymap.set('n', '<leader>fg', builtin.live_grep, { desc = 'Telescope live grep' })
163+
vim.keymap.set('n', '<leader>fb', builtin.buffers, { desc = 'Telescope buffers' })
164+
vim.keymap.set('n', '<leader>fh', builtin.help_tags, { desc = 'Telescope help tags' })
165165
```
166166

167167
See [builtin pickers](#pickers) for a list of all builtin functions.

0 commit comments

Comments
 (0)