Skip to content

Commit 6b08cdc

Browse files
jamestrewGithub Actions
andauthored
docs(builtin.tags): add show_kind option (#3304)
* docs(builtin.tags): add `show_kind` option * [docgen] Update doc/telescope.txt skip-checks: true --------- Co-authored-by: Github Actions <actions@github>
1 parent 21bfcc3 commit 6b08cdc

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

doc/telescope.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,6 +1012,8 @@ builtin.tags({opts}) *telescope.builtin.tags()*
10121012
{show_line} (boolean) if true, shows the content of the line the
10131013
tag is found on in the picker (default:
10141014
true)
1015+
{show_kind} (boolean) if true and kind info is available, show
1016+
the kind of the tag (default: true)
10151017
{only_sort_tags} (boolean) if true we will only sort tags (default:
10161018
false)
10171019
{fname_width} (number) defines the width of the filename section
@@ -1033,6 +1035,8 @@ builtin.current_buffer_tags({opts}) *telescope.builtin.current_buffer_tags()*
10331035
{show_line} (boolean) if true, shows the content of the line the
10341036
tag is found on in the picker (default:
10351037
true)
1038+
{show_kind} (boolean) if true and kind info is available, show
1039+
the kind of the tag (default: true)
10361040
{only_sort_tags} (boolean) if true we will only sort tags (default:
10371041
false)
10381042
{fname_width} (number) defines the width of the filename section

lua/telescope/builtin/init.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ builtin.current_buffer_fuzzy_find = require_on_exported_call("telescope.builtin.
114114
---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer)
115115
---@field ctags_file string: specify a particular ctags file to use
116116
---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true)
117+
---@field show_kind boolean: if true and kind info is available, show the kind of the tag (default: true)
117118
---@field only_sort_tags boolean: if true we will only sort tags (default: false)
118119
---@field fname_width number: defines the width of the filename section (default: 30)
119120
builtin.tags = require_on_exported_call("telescope.builtin.__files").tags
@@ -123,6 +124,7 @@ builtin.tags = require_on_exported_call("telescope.builtin.__files").tags
123124
---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer)
124125
---@field ctags_file string: specify a particular ctags file to use
125126
---@field show_line boolean: if true, shows the content of the line the tag is found on in the picker (default: true)
127+
---@field show_kind boolean: if true and kind info is available, show the kind of the tag (default: true)
126128
---@field only_sort_tags boolean: if true we will only sort tags (default: false)
127129
---@field fname_width number: defines the width of the filename section (default: 30)
128130
builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__files").current_buffer_tags

0 commit comments

Comments
 (0)