leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Git actions docs fix (#787)

Browse Source 
* Removed function headers for git actions

* [docgen] Update doc/telescope.txt
skip-checks: true

* [docgen] Update doc/telescope.txt
skip-checks: true

* Added TODO & comments instead of removing headers

* [docgen] Update doc/telescope.txt
skip-checks: true

Co-authored-by: Github Actions <actions@github>
This commit is contained in:
Ben Smith
2021-04-23 18:16:44 +00:00
committed by GitHub
parent 712de3e182
commit 6fd1b3bd25
2 changed files with 25 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/telescope.txt
View File

@@ -148,6 +148,22 @@ action_set.scroll_previewer({prompt_bufnr}, {direction})*action_set.scroll_previ
Actions functions that are useful for people creating their own mappings.
actions.move_selection_next({prompt_bufnr}) *actions.move_selection_next()*
Move the selection to the next entry
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.move_selection_previous({prompt_bufnr})*actions.move_selection_previous()*
Move the selection to the previous entry
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.move_selection_worse({prompt_bufnr}) *actions.move_selection_worse()*
Move the selection to the entry that has a worse score
@@ -236,30 +252,6 @@ actions.git_track_branch({prompt_bufnr}) *actions.git_track_branch()*
{prompt_bufnr} (number) The prompt bufnr
actions.git_delete_branch({prompt_bufnr}) *actions.git_delete_branch()*
Delete the currently selected branch
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.git_rebase_branch({prompt_bufnr}) *actions.git_rebase_branch()*
Rebase to selected git branch
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.git_staging_toggle({prompt_bufnr}) *actions.git_staging_toggle()*
Stage/unstage selected file
Parameters: ~
{prompt_bufnr} (number) The prompt bufnr
actions.open_qflist() *actions.open_qflist()*
Open the quickfix list

15
lua/telescope/actions/init.lua
View File

@@ -376,8 +376,9 @@ actions.git_track_branch = function(prompt_bufnr)
end
end
--- Delete the currently selected branch
---@param prompt_bufnr number: The prompt bufnr
-- TODO: add this function header back once the treesitter max-query bug is resolved
-- Delete the currently selected branch
-- @param prompt_bufnr number: The prompt bufnr
actions.git_delete_branch = function(prompt_bufnr)
local cwd = action_state.get_current_picker(prompt_bufnr).cwd
local selection = action_state.get_selected_entry()
@@ -398,8 +399,9 @@ actions.git_delete_branch = function(prompt_bufnr)
end
end
--- Rebase to selected git branch
---@param prompt_bufnr number: The prompt bufnr
-- TODO: add this function header back once the treesitter max-query bug is resolved
-- Rebase to selected git branch
-- @param prompt_bufnr number: The prompt bufnr
actions.git_rebase_branch = function(prompt_bufnr)
local cwd = action_state.get_current_picker(prompt_bufnr).cwd
local selection = action_state.get_selected_entry()
@@ -420,8 +422,9 @@ actions.git_rebase_branch = function(prompt_bufnr)
end
end
--- Stage/unstage selected file
---@param prompt_bufnr number: The prompt bufnr
-- TODO: add this function header back once the treesitter max-query bug is resolved
-- Stage/unstage selected file
-- @param prompt_bufnr number: The prompt bufnr
actions.git_staging_toggle = function(prompt_bufnr)
local cwd = action_state.get_current_picker(prompt_bufnr).cwd
local selection = action_state.get_selected_entry()