From 5ce991ad23253750d189c23e7688ca68898ea48b Mon Sep 17 00:00:00 2001 From: Uraza Date: Sun, 19 Feb 2023 11:17:05 +0100 Subject: [PATCH] docs: add missing documentation for builtin lsp symbols (#2365) --- doc/telescope.txt | 8 ++++++++ lua/telescope/builtin/init.lua | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/doc/telescope.txt b/doc/telescope.txt index 95e2df0..0012eb0 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -1557,6 +1557,10 @@ builtin.lsp_document_symbols({opts}) *telescope.builtin.lsp_document_symbols()* Options: ~ {fname_width} (number) defines the width of the filename section (default: 30) + {symbol_width} (number) defines the width of the symbol + section (default: 25) + {symbol_type_width} (number) defines the width of the symbol + type section (default: 8) {show_line} (boolean) if true, shows the content of the line the tag is found on (default: false) @@ -1581,6 +1585,10 @@ builtin.lsp_workspace_symbols({opts}) *telescope.builtin.lsp_workspace_symbols() (default: "") {fname_width} (number) defines the width of the filename section (default: 30) + {symbol_width} (number) defines the width of the symbol + section (default: 25) + {symbol_type_width} (number) defines the width of the symbol + type section (default: 8) {show_line} (boolean) if true, shows the content of the line the tag is found on (default: false) diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 65a8cac..c9c0ae3 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -429,6 +429,8 @@ builtin.lsp_implementations = require_on_exported_call("telescope.builtin.__lsp" --- - ``: show autocompletion menu to prefilter your query by type of symbol you want to see (i.e. `:variable:`) ---@param opts table: options to pass to the picker ---@field fname_width number: defines the width of the filename section (default: 30) +---@field symbol_width number: defines the width of the symbol section (default: 25) +---@field symbol_type_width number: defines the width of the symbol type section (default: 8) ---@field show_line boolean: if true, shows the content of the line the tag is found on (default: false) ---@field symbols string|table: filter results by symbol kind(s) ---@field ignore_symbols string|table: list of symbols to ignore @@ -441,6 +443,8 @@ builtin.lsp_document_symbols = require_on_exported_call("telescope.builtin.__lsp ---@param opts table: options to pass to the picker ---@field query string: for what to query the workspace (default: "") ---@field fname_width number: defines the width of the filename section (default: 30) +---@field symbol_width number: defines the width of the symbol section (default: 25) +---@field symbol_type_width number: defines the width of the symbol type section (default: 8) ---@field show_line boolean: if true, shows the content of the line the tag is found on (default: false) ---@field symbols string|table: filter results by symbol kind(s) ---@field ignore_symbols string|table: list of symbols to ignore