summaryrefslogtreecommitdiff
path: root/lua/telescope/themes.lua
diff options
context:
space:
mode:
authorJames Trew <66286082+jamestrew@users.noreply.github.com>2023-01-22 03:57:53 -0500
committerGitHub <noreply@github.com>2023-01-22 09:57:53 +0100
commit053f2303c4fac5c45a56b9de0a7481b7db94d6ba (patch)
tree8520fa13cfb0008d111ad17038748303891a9f7f /lua/telescope/themes.lua
parented366bba143d9babd2b81eb46c4f0f482051778d (diff)
docs: proof-read edits (#2311)
Diffstat (limited to 'lua/telescope/themes.lua')
-rw-r--r--lua/telescope/themes.lua22
1 files changed, 12 insertions, 10 deletions
diff --git a/lua/telescope/themes.lua b/lua/telescope/themes.lua
index 0fe5d99..69d12e8 100644
--- a/lua/telescope/themes.lua
+++ b/lua/telescope/themes.lua
@@ -19,9 +19,10 @@ local themes = {}
---
--- Usage:
--- <code>
---- `local builtin = require('telescope.builtin')`
---- `local themes = require('telescope.themes')`
---- `builtin.find_files(themes.get_dropdown())`
+--- local opts = {...} -- picker options
+--- local builtin = require('telescope.builtin')
+--- local themes = require('telescope.themes')
+--- builtin.find_files(themes.get_dropdown(opts))
--- </code>
function themes.get_dropdown(opts)
opts = opts or {}
@@ -67,10 +68,10 @@ end
---
--- Usage:
--- <code>
----
---- `local builtin = require('telescope.builtin')`
---- `local themes = require('telescope.themes')`
---- `builtin.lsp_references(themes.get_cursor())`
+--- local opts = {...} -- picker options
+--- local builtin = require('telescope.builtin')
+--- local themes = require('telescope.themes')
+--- builtin.find_files(themes.get_cursor(opts))
--- </code>
function themes.get_cursor(opts)
opts = opts or {}
@@ -99,9 +100,10 @@ end
---
--- Usage:
--- <code>
---- `local builtin = require('telescope.builtin')`
---- `local themes = require('telescope.themes')`
---- `builtin.find_files(themes.get_ivy())`
+--- local opts = {...} -- picker options
+--- local builtin = require('telescope.builtin')
+--- local themes = require('telescope.themes')
+--- builtin.find_files(themes.get_ivy(opts))
--- </code>
function themes.get_ivy(opts)
opts = opts or {}