summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLuke Kershaw <35707277+l-kershaw@users.noreply.github.com>2021-11-13 11:15:07 +0000
committerGitHub <noreply@github.com>2021-11-13 11:15:07 +0000
commitbf77c5d2fab49cf932c9ebfc98be3b7ce2ac3bad (patch)
tree1a568b4e3d177dca703faa978262fd31deaea765 /doc
parent3d45c6c55537c8c95a6b2ea8653f5a491131def7 (diff)
feat: results scrolling actions (#1436)
Diffstat (limited to 'doc')
-rw-r--r--doc/telescope.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/telescope.txt b/doc/telescope.txt
index 7f7f89f..8517b04 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -2190,7 +2190,20 @@ action_set.edit({prompt_bufnr}, {command}) *action_set.edit()*
action_set.scroll_previewer({prompt_bufnr}, {direction}) *action_set.scroll_previewer()*
- Scrolls the previewer up or down
+ Scrolls the previewer up or down. Defaults to a half page scroll, but can
+ be overridden using the `scroll_speed` option in `layout_config`. See
+ |telescope.layout| for more details.
+
+
+ Parameters: ~
+ {prompt_bufnr} (number) The prompt bufnr
+ {direction} (number) The direction of the scrolling
+
+
+action_set.scroll_results({prompt_bufnr}, {direction}) *action_set.scroll_results()*
+ Scrolls the results up or down. Defaults to a half page scroll, but can be
+ overridden using the `scroll_speed` option in `layout_config`. See
+ |telescope.layout| for more details.
Parameters: ~