From 6fd1b3bd255a6ebc2e44cec367ff60ce8e6e6cab Mon Sep 17 00:00:00 2001
From: Ben Smith <37027883+smithbm2316@users.noreply.github.com>
Date: Fri, 23 Apr 2021 18:16:44 +0000
Subject: [PATCH] docs: Git actions docs fix (#787)

* 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>
---
 doc/telescope.txt              | 40 ++++++++++++++--------------------
 lua/telescope/actions/init.lua | 15 ++++++++-----
 2 files changed, 25 insertions(+), 30 deletions(-)

diff --git a/doc/telescope.txt b/doc/telescope.txt
index 1bf9c3f..4ad4d42 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -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
 
diff --git a/lua/telescope/actions/init.lua b/lua/telescope/actions/init.lua
index a14255b..1677e10 100644
--- a/lua/telescope/actions/init.lua
+++ b/lua/telescope/actions/init.lua
@@ -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()