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

docs(builtin.tags): add show_kind option (#3304)

Browse Source 
* docs(builtin.tags): add `show_kind` option

* [docgen] Update doc/telescope.txt
skip-checks: true

---------

Co-authored-by: Github Actions <actions@github>
This commit is contained in:
James Trew
2024-09-25 02:44:41 +00:00
committed by GitHub
parent 21bfcc3e39
commit 6b08cdcc22
2 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/telescope.txt
View File

@@ -1012,6 +1012,8 @@ builtin.tags({opts}) *telescope.builtin.tags()*
{show_line} (boolean) if true, shows the content of the line the {show_line} (boolean) if true, shows the content of the line the
tag is found on in the picker (default: tag is found on in the picker (default:
true) true)
{show_kind} (boolean) if true and kind info is available, show
the kind of the tag (default: true)
{only_sort_tags} (boolean) if true we will only sort tags (default: {only_sort_tags} (boolean) if true we will only sort tags (default:
false) false)
{fname_width} (number) defines the width of the filename section {fname_width} (number) defines the width of the filename section
@@ -1033,6 +1035,8 @@ builtin.current_buffer_tags({opts}) *telescope.builtin.current_buffer_tags()*
{show_line} (boolean) if true, shows the content of the line the {show_line} (boolean) if true, shows the content of the line the
tag is found on in the picker (default: tag is found on in the picker (default:
true) true)
{show_kind} (boolean) if true and kind info is available, show
the kind of the tag (default: true)
{only_sort_tags} (boolean) if true we will only sort tags (default: {only_sort_tags} (boolean) if true we will only sort tags (default:
false) false)
{fname_width} (number) defines the width of the filename section {fname_width} (number) defines the width of the filename section

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

@@ -114,6 +114,7 @@ builtin.current_buffer_fuzzy_find = require_on_exported_call("telescope.builtin.
---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer) ---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer)
---@field ctags_file string: specify a particular ctags file to use ---@field ctags_file string: specify a particular ctags file to use
---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true) ---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true)
---@field show_kind boolean: if true and kind info is available, show the kind of the tag (default: true)
---@field only_sort_tags boolean: if true we will only sort tags (default: false) ---@field only_sort_tags boolean: if true we will only sort tags (default: false)
---@field fname_width number: defines the width of the filename section (default: 30) ---@field fname_width number: defines the width of the filename section (default: 30)
builtin.tags = require_on_exported_call("telescope.builtin.__files").tags builtin.tags = require_on_exported_call("telescope.builtin.__files").tags
@@ -123,6 +124,7 @@ builtin.tags = require_on_exported_call("telescope.builtin.__files").tags
---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer) ---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer)
---@field ctags_file string: specify a particular ctags file to use ---@field ctags_file string: specify a particular ctags file to use
---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true) ---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true)
---@field show_kind boolean: if true and kind info is available, show the kind of the tag (default: true)
---@field only_sort_tags boolean: if true we will only sort tags (default: false) ---@field only_sort_tags boolean: if true we will only sort tags (default: false)
---@field fname_width number: defines the width of the filename section (default: 30) ---@field fname_width number: defines the width of the filename section (default: 30)
builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__files").current_buffer_tags builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__files").current_buffer_tags