leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add missing documentation for builtin lsp symbols (#2365)

Browse Source
This commit is contained in:
Uraza
2023-02-19 11:17:05 +01:00
committed by GitHub
parent b0395c2882
commit 5ce991ad23
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/telescope.txt
View File

@@ -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)

4
lua/telescope/builtin/init.lua
View File

@@ -429,6 +429,8 @@ builtin.lsp_implementations = require_on_exported_call("telescope.builtin.__lsp"
--- - `<C-l>`: 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