Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show kind docs #3304

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Show kind docs #3304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55ddbb3
docs(builtin.tags): add `show_kind` option
jamestrew Sep 25, 2024
7c67102
[docgen] Update doc/telescope.txt
Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/telescope.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,6 +1012,8 @@ builtin.tags({opts}) *telescope.builtin.tags()*
{show_line} (boolean) if true, shows the content of the line the
tag is found on in the picker (default:
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:
false)
{fname_width} (number) defines the width of the filename section
Expand All @@ -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
tag is found on in the picker (default:
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:
false)
{fname_width} (number) defines the width of the filename section
Expand Down
2 changes: 2 additions & 0 deletions lua/telescope/builtin/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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_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 fname_width number: defines the width of the filename section (default: 30)
builtin.tags = require_on_exported_call("telescope.builtin.__files").tags
Expand All @@ -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 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_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 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
Expand Down