doc: help for select_{default,tab,vertical,horizontal} (#1801)

This commit is contained in:
Jonathan Birk
2022-03-20 19:08:54 +00:00
committed by GitHub
parent 8c7ac1df9d
commit 6a43634f5f
2 changed files with 64 additions and 0 deletions

View File

@@ -1966,6 +1966,50 @@ actions.toggle_all({prompt_bufnr}) *actions.toggle_all()*
{prompt_bufnr} (number) The prompt bufnr
actions.select_default({prompt_bufnr}) *actions.select_default()*
Perform default action on selection, usually something like
`:edit <selection>`
i.e. open the selection in the current buffer
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.select_horizontal({prompt_bufnr}) *actions.select_horizontal()*
Perform 'horizontal' action on selection, usually something like
`:new <selection>`
i.e. open the selection in a new horizontal split
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.select_vertical({prompt_bufnr}) *actions.select_vertical()*
Perform 'vertical' action on selection, usually something like
`:vnew <selection>`
i.e. open the selection in a new vertical split
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.select_tab({prompt_bufnr}) *actions.select_tab()*
Perform 'tab' action on selection, usually something like
`:tabedit <selection>`
i.e. open the selection in a new tab
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.git_create_branch({prompt_bufnr}) *actions.git_create_branch()*
Create and checkout a new git branch if it doesn't already exist

View File

@@ -179,6 +179,11 @@ function actions.center(_)
vim.cmd ":normal! zz"
end
--- Perform default action on selection, usually something like<br>
--- `:edit <selection>`
---
--- i.e. open the selection in the current buffer
---@param prompt_bufnr number: The prompt bufnr
actions.select_default = {
pre = function(prompt_bufnr)
action_state.get_current_history():append(
@@ -191,6 +196,11 @@ actions.select_default = {
end,
}
--- Perform 'horizontal' action on selection, usually something like<br>
---`:new <selection>`
---
--- i.e. open the selection in a new horizontal split
---@param prompt_bufnr number: The prompt bufnr
actions.select_horizontal = {
pre = function(prompt_bufnr)
action_state.get_current_history():append(
@@ -203,6 +213,11 @@ actions.select_horizontal = {
end,
}
--- Perform 'vertical' action on selection, usually something like<br>
---`:vnew <selection>`
---
--- i.e. open the selection in a new vertical split
---@param prompt_bufnr number: The prompt bufnr
actions.select_vertical = {
pre = function(prompt_bufnr)
action_state.get_current_history():append(
@@ -215,6 +230,11 @@ actions.select_vertical = {
end,
}
--- Perform 'tab' action on selection, usually something like<br>
---`:tabedit <selection>`
---
--- i.e. open the selection in a new tab
---@param prompt_bufnr number: The prompt bufnr
actions.select_tab = {
pre = function(prompt_bufnr)
action_state.get_current_history():append(