Skip to content

Commit

Permalink
docs: add missing documentation for builtin lsp symbols (#2365)
Browse files Browse the repository at this point in the history
(cherry picked from commit 5ce991a)
  • Loading branch information
uraza authored and Conni2461 committed Feb 19, 2023
1 parent 996eb19 commit 9e55b91
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/telescope.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1523,6 +1523,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)
Expand All @@ -1547,6 +1551,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)
Expand Down
4 changes: 4 additions & 0 deletions lua/telescope/builtin/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,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
Expand All @@ -433,6 +435,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
Expand Down

0 comments on commit 9e55b91

Please sign in to comment.