AdeAttwood/ivy.nvim
1
0
Fork 0
Code Issues Pull requests Projects Wiki Activity Actions

docs: remove 'peek' from the docs

Browse source 
Summary:

When we were flushing out the docs, we found some inconsistency in the naming
of checkpoint and peek. They were referring to the same thing.

This removes the word 'peek' in favor of 'checkpoint'

Test Plan:

N / A
This commit is contained in:
Ade Attwood 2024-06-27 21:26:57 +01:00
parent 72551eea66
commit 740263cb2a
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -83,7 +83,6 @@ Action can be run on selected candidates provide functionality
| Action | Key Map | Description |
| -------------- | ----------- | ------------------------------------------------------------------------------ |
| Complete | \<CR\> |Run the completion function, usually this will be opening a file |
| Peek | not implemented yet |Run the completion function on a selection, but don't close the results window |
| Vertical Split | \<C-v\> |Run the completion function in a new vertical split |
| Split | \<C-s\> |Run the completion function in a new split |
| Destroy | \<C-c\> |Close the results window |
@ -153,7 +152,7 @@ vertical split action it will open the buffer in a new `vsplit`
{ content = "Three" },
}
end,
-- Action callback that will be called on the completion or peek actions.
-- Action callback that will be called on the completion or checkpoint actions.
-- The currently selected item is passed in as the result.
function(result) vim.cmd("edit " .. result) end
)