summaryrefslogtreecommitdiff
path: root/lua/telescope/builtin/init.lua
diff options
context:
space:
mode:
authorSimon Hauser <Simon-Hauser@outlook.de>2021-08-21 16:48:19 +0200
committerGitHub <noreply@github.com>2021-08-21 16:48:19 +0200
commit364d795d22e7a080be793379e30cfdd2036840cf (patch)
tree05ea225d8a08374347d61f42d8ce36704e34c1d0 /lua/telescope/builtin/init.lua
parent81ab591180e22150b00d464008c4cd82c3e8d86d (diff)
fix: some improvements for telescope.symbols if run in insert mode (#1117)
- keep insert if run in insert mode - also look in `.local/share/nvim/telescope/symbols/*.json` for symbols can be overriden with `symbol_path`
Diffstat (limited to 'lua/telescope/builtin/init.lua')
-rw-r--r--lua/telescope/builtin/init.lua10
1 files changed, 8 insertions, 2 deletions
diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua
index 70c4302..9dc29af 100644
--- a/lua/telescope/builtin/init.lua
+++ b/lua/telescope/builtin/init.lua
@@ -202,8 +202,14 @@ builtin.builtin = require("telescope.builtin.internal").builtin
---@param opts table: options to pass to the picker
builtin.planets = require("telescope.builtin.internal").planets
---- Lists symbols inside of data/telescope-sources/*.json found in your runtime path. Check README for more info
----@param opts table: options to pass to the picker
+--- Lists symbols inside of `data/telescope-sources/*.json` found in your runtime path
+--- or found in `stdpath("data")/telescope/symbols/*.json`. The second path can be customized.
+--- We provide a couple of default symbols which can be found in
+--- https://github.com/nvim-telescope/telescope-symbols.nvim. This repos README also provides more
+--- information about the format in which the symbols have to be.
+---@param opts table: options to pass to the picker
+---@field symbol_path string: specify the second path. Default: `stdpath("data")/telescope/symbols/*.json`
+---@field sources table: specify a table of sources you want to load this time
builtin.symbols = require("telescope.builtin.internal").symbols
--- Lists available plugin/user commands and runs them on `<cr>`