From 72f3fcac4ec30d31d7babc095dc7a73291d015b1 Mon Sep 17 00:00:00 2001 From: Ade Attwood Date: Thu, 27 Jun 2024 21:26:57 +0100 Subject: [PATCH] docs: remove 'peek' from the docs 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 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index eb0532d..fe098ed 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,6 @@ Action can be run on selected candidates provide functionality | Action | Key Map | Description | | -------------- | ----------- | ------------------------------------------------------------------------------ | | Complete | \ |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 | \ |Run the completion function in a new vertical split | | Split | \ |Run the completion function in a new split | | Destroy | \ |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 )