From 3dbd188e530997603d35ff9aa0e4615dd9aed19f Mon Sep 17 00:00:00 2001 From: Craig Rodrigues Date: Mon, 2 Sep 2024 21:55:07 -0700 Subject: [PATCH 1/2] Add human readable description to keymap --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e3a9b76aa0..65b99697b3 100644 --- a/README.md +++ b/README.md @@ -158,10 +158,10 @@ Using Lua: ```lua local builtin = require('telescope.builtin') -vim.keymap.set('n', 'ff', builtin.find_files, {}) -vim.keymap.set('n', 'fg', builtin.live_grep, {}) -vim.keymap.set('n', 'fb', builtin.buffers, {}) -vim.keymap.set('n', 'fh', builtin.help_tags, {}) +vim.keymap.set('n', 'ff', builtin.find_files, { desc = 'Telescope find files' }) +vim.keymap.set('n', 'fg', builtin.live_grep, { desc = 'Telescope live grep' }) +vim.keymap.set('n', 'fb', builtin.buffers, { desc = 'Telescope buffers' }) +vim.keymap.set('n', 'fh', builtin.help_tags, { desc= 'Telescope help tags' }) ``` See [builtin pickers](#pickers) for a list of all builtin functions. From 6704733c69bc82257b218333ace823fb6869edd9 Mon Sep 17 00:00:00 2001 From: Craig Rodrigues Date: Tue, 17 Sep 2024 18:17:55 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: James Trew <66286082+jamestrew@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65b99697b3..e5bfdfd7a6 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ local builtin = require('telescope.builtin') vim.keymap.set('n', 'ff', builtin.find_files, { desc = 'Telescope find files' }) vim.keymap.set('n', 'fg', builtin.live_grep, { desc = 'Telescope live grep' }) vim.keymap.set('n', 'fb', builtin.buffers, { desc = 'Telescope buffers' }) -vim.keymap.set('n', 'fh', builtin.help_tags, { desc= 'Telescope help tags' }) +vim.keymap.set('n', 'fh', builtin.help_tags, { desc = 'Telescope help tags' }) ``` See [builtin pickers](#pickers) for a list of all builtin functions.