From 8fe2dde6560667217682b22d77e1e719b7156cda Mon Sep 17 00:00:00 2001 From: Simon Hauser Date: Wed, 6 Jul 2022 20:45:40 +0200 Subject: [PATCH] docs: add missing opts docs for lsp builtins --- doc/telescope.txt | 33 ++++++++++++++++++++++----------- lua/telescope/builtin/init.lua | 14 ++++++++++---- 2 files changed, 32 insertions(+), 15 deletions(-) diff --git a/doc/telescope.txt b/doc/telescope.txt index eb980d1..5b2dcd5 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -1475,9 +1475,10 @@ builtin.lsp_references({opts}) *telescope.builtin.lsp_references()* lsp references (default: true) {include_current_line} (boolean) include current line (default: false) - {trim_text} (boolean) trim results text (default: false) {fname_width} (number) defines the width of the filename section (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_incoming_calls({opts}) *telescope.builtin.lsp_incoming_calls()* @@ -1489,8 +1490,10 @@ builtin.lsp_incoming_calls({opts}) *telescope.builtin.lsp_incoming_calls()* {opts} (table) options to pass to the picker Options: ~ - {show_line} (boolean) show results text (default: true) - {trim_text} (boolean) trim results text (default: false) + {fname_width} (number) defines the width of the filename section + (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_outgoing_calls({opts}) *telescope.builtin.lsp_outgoing_calls()* @@ -1502,8 +1505,10 @@ builtin.lsp_outgoing_calls({opts}) *telescope.builtin.lsp_outgoing_calls()* {opts} (table) options to pass to the picker Options: ~ - {show_line} (boolean) show results text (default: true) - {trim_text} (boolean) trim results text (default: false) + {fname_width} (number) defines the width of the filename section + (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_definitions({opts}) *telescope.builtin.lsp_definitions()* @@ -1517,10 +1522,10 @@ builtin.lsp_definitions({opts}) *telescope.builtin.lsp_definitions()* Options: ~ {jump_type} (string) how to goto definition if there is only one, values: "tab", "split", "vsplit", "never" - {show_line} (boolean) show results text (default: true) - {trim_text} (boolean) trim results text (default: false) {fname_width} (number) defines the width of the filename section (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_type_definitions({opts}) *telescope.builtin.lsp_type_definitions()* @@ -1534,10 +1539,10 @@ builtin.lsp_type_definitions({opts}) *telescope.builtin.lsp_type_definitions()* Options: ~ {jump_type} (string) how to goto definition if there is only one, values: "tab", "split", "vsplit", "never" - {show_line} (boolean) show results text (default: true) - {trim_text} (boolean) trim results text (default: false) {fname_width} (number) defines the width of the filename section (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_implementations({opts}) *telescope.builtin.lsp_implementations()* @@ -1552,10 +1557,10 @@ builtin.lsp_implementations({opts}) *telescope.builtin.lsp_implementations()* {jump_type} (string) how to goto implementation if there is only one, values: "tab", "split", "vsplit", "never" - {show_line} (boolean) show results text (default: true) - {trim_text} (boolean) trim results text (default: false) {fname_width} (number) defines the width of the filename section (default: 30) + {show_line} (boolean) show results text (default: true) + {trim_text} (boolean) trim results text (default: false) builtin.lsp_document_symbols({opts}) *telescope.builtin.lsp_document_symbols()* @@ -1569,6 +1574,8 @@ builtin.lsp_document_symbols({opts}) *telescope.builtin.lsp_document_symbols()* {opts} (table) options to pass to the picker Options: ~ + {fname_width} (number) defines the width of the filename + section (default: 30) {show_line} (boolean) if true, shows the content of the line the tag is found on (default: false) @@ -1591,6 +1598,8 @@ builtin.lsp_workspace_symbols({opts}) *telescope.builtin.lsp_workspace_symbols() Options: ~ {query} (string) for what to query the workspace (default: "") + {fname_width} (number) defines the width of the filename + section (default: 30) {show_line} (boolean) if true, shows the content of the line the tag is found on (default: false) @@ -1611,6 +1620,8 @@ builtin.lsp_dynamic_workspace_symbols({opts}) *telescope.builtin.lsp_dynamic_wor {opts} (table) options to pass to the picker Options: ~ + {fname_width} (number) defines the width of the filename + section (default: 30) {show_line} (boolean) if true, shows the content of the line the symbol is found on (default: false) diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 804b663..74323d4 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -376,18 +376,21 @@ builtin.jumplist = require_on_exported_call("telescope.builtin.__internal").jump ---@param opts table: options to pass to the picker ---@field include_declaration boolean: include symbol declaration in the lsp references (default: true) ---@field include_current_line boolean: include current line (default: false) ----@field trim_text boolean: trim results text (default: false) ---@field fname_width number: defines the width of the filename section (default: 30) +---@field show_line boolean: show results text (default: true) +---@field trim_text boolean: trim results text (default: false) builtin.lsp_references = require_on_exported_call("telescope.builtin.__lsp").references --- Lists LSP incoming calls for word under the cursor, jumps to reference on `` ---@param opts table: options to pass to the picker +---@field fname_width number: defines the width of the filename section (default: 30) ---@field show_line boolean: show results text (default: true) ---@field trim_text boolean: trim results text (default: false) builtin.lsp_incoming_calls = require_on_exported_call("telescope.builtin.__lsp").incoming_calls --- Lists LSP outgoing calls for word under the cursor, jumps to reference on `` ---@param opts table: options to pass to the picker +---@field fname_width number: defines the width of the filename section (default: 30) ---@field show_line boolean: show results text (default: true) ---@field trim_text boolean: trim results text (default: false) builtin.lsp_outgoing_calls = require_on_exported_call("telescope.builtin.__lsp").outgoing_calls @@ -395,32 +398,33 @@ builtin.lsp_outgoing_calls = require_on_exported_call("telescope.builtin.__lsp") --- Goto the definition of the word under the cursor, if there's only one, otherwise show all options in Telescope ---@param opts table: options to pass to the picker ---@field jump_type string: how to goto definition if there is only one, values: "tab", "split", "vsplit", "never" +---@field fname_width number: defines the width of the filename section (default: 30) ---@field show_line boolean: show results text (default: true) ---@field trim_text boolean: trim results text (default: false) ----@field fname_width number: defines the width of the filename section (default: 30) builtin.lsp_definitions = require_on_exported_call("telescope.builtin.__lsp").definitions --- Goto the definition of the type of the word under the cursor, if there's only one, --- otherwise show all options in Telescope ---@param opts table: options to pass to the picker ---@field jump_type string: how to goto definition if there is only one, values: "tab", "split", "vsplit", "never" +---@field fname_width number: defines the width of the filename section (default: 30) ---@field show_line boolean: show results text (default: true) ---@field trim_text boolean: trim results text (default: false) ----@field fname_width number: defines the width of the filename section (default: 30) builtin.lsp_type_definitions = require("telescope.builtin.__lsp").type_definitions --- Goto the implementation of the word under the cursor if there's only one, otherwise show all options in Telescope ---@param opts table: options to pass to the picker ---@field jump_type string: how to goto implementation if there is only one, values: "tab", "split", "vsplit", "never" +---@field fname_width number: defines the width of the filename section (default: 30) ---@field show_line boolean: show results text (default: true) ---@field trim_text boolean: trim results text (default: false) ----@field fname_width number: defines the width of the filename section (default: 30) builtin.lsp_implementations = require_on_exported_call("telescope.builtin.__lsp").implementations --- Lists LSP document symbols in the current buffer --- - Default keymaps: --- - ``: 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 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 @@ -432,6 +436,7 @@ builtin.lsp_document_symbols = 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 query string: for what to query the workspace (default: "") +---@field fname_width number: defines the width of the filename section (default: 30) ---@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 @@ -442,6 +447,7 @@ builtin.lsp_workspace_symbols = require_on_exported_call("telescope.builtin.__ls --- - Default keymaps: --- - ``: 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 show_line boolean: if true, shows the content of the line the symbol 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