summaryrefslogtreecommitdiff
path: root/lua/telescope/mappings.lua
diff options
context:
space:
mode:
authorJames Trew <66286082+jamestrew@users.noreply.github.com>2023-01-22 03:57:53 -0500
committerGitHub <noreply@github.com>2023-01-22 09:57:53 +0100
commit053f2303c4fac5c45a56b9de0a7481b7db94d6ba (patch)
tree8520fa13cfb0008d111ad17038748303891a9f7f /lua/telescope/mappings.lua
parented366bba143d9babd2b81eb46c4f0f482051778d (diff)
docs: proof-read edits (#2311)
Diffstat (limited to 'lua/telescope/mappings.lua')
-rw-r--r--lua/telescope/mappings.lua10
1 files changed, 4 insertions, 6 deletions
diff --git a/lua/telescope/mappings.lua b/lua/telescope/mappings.lua
index 45fad81..60ccc27 100644
--- a/lua/telescope/mappings.lua
+++ b/lua/telescope/mappings.lua
@@ -2,12 +2,11 @@
---@brief [[
--- |telescope.mappings| is used to configure the keybindings within
---- a telescope picker. These keybinds are only local to the picker window
+--- a telescope picker. These key binds are only local to the picker window
--- and will be cleared once you exit the picker.
---
---- We provide multiple different ways of configuring, as described below,
---- to provide an easy to use experience for changing the default behavior
---- of telescope or extending for your own purposes.
+--- We provide multiple configuration options to make it easy for you to adjust
+--- telescope's default key bindings and create your own custom key binds.
---
--- To see many of the builtin actions that you can use as values for this
--- table, see |telescope.actions|
@@ -39,7 +38,6 @@
--- ...,
--- }
--- </code>
---- Into your config.
---
--- To override behavior of a key, simply set the value
--- to be a function (either by requiring an action or by writing
@@ -53,7 +51,7 @@
--- </code>
---
--- If the function you want is part of `telescope.actions`, then you can
---- simply give a string.
+--- simply supply the function name as a string.
--- For example, the previous option is equivalent to:
--- <code>
--- {