diff --git a/doc/telescope.txt b/doc/telescope.txt index 7fc66e2..ce171f1 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -827,8 +827,8 @@ builtin.live_grep({opts}) *telescope.builtin.live_grep()* {grep_open_files} (boolean) if true, restrict search to open files only, mutually exclusive with `search_dirs` - {search_dirs} (table) directory/directories to search in, - mutually exclusive with + {search_dirs} (table) directory/directories/files to + search, mutually exclusive with `grep_open_files` {glob_pattern} (string) argument to be used with `--glob`, e.g. "*.toml", can use the opposite @@ -855,7 +855,8 @@ builtin.grep_string({opts}) *telescope.builtin.grep_string()* cwd, use utils.buffer_dir() to search relative to open buffer) {search} (string) the query to search - {search_dirs} (table) directory/directories to search in + {search_dirs} (table) directory/directories/files to + search {use_regex} (boolean) if true, special characters won't be escaped, allows for using regex (default: false) @@ -894,8 +895,8 @@ builtin.find_files({opts}) *telescope.builtin.find_files()* {no_ignore_parent} (boolean) show files ignored by .gitignore, .ignore, etc. in parent dirs. (default: false) - {search_dirs} (table) directory/directories to search - in + {search_dirs} (table) directory/directories/files to + search builtin.fd() *telescope.builtin.fd()* @@ -2830,7 +2831,8 @@ Generally used from within other |telescope.actions| utils.map_entries({prompt_bufnr}, {f}) *telescope.actions.utils.map_entries()* Apply `f` to the entries of the current picker. - Notes: - - Mapped entries may include results not visible in the results popup. + - Mapped entries include all currently filtered results, not just the + visible onces. - Indices are 1-indexed, whereas rows are 0-indexed. - Warning: `map_entries` has no return value. - The below example showcases how to collect results diff --git a/lua/telescope/actions/utils.lua b/lua/telescope/actions/utils.lua index 9684414..4e81db3 100644 --- a/lua/telescope/actions/utils.lua +++ b/lua/telescope/actions/utils.lua @@ -13,7 +13,7 @@ local utils = {} --- Apply `f` to the entries of the current picker. --- - Notes: ---- - Mapped entries may include results not visible in the results popup. +--- - Mapped entries include all currently filtered results, not just the visible onces. --- - Indices are 1-indexed, whereas rows are 0-indexed. --- - Warning: `map_entries` has no return value. --- - The below example showcases how to collect results diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 69c83ba..7a3fb14 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -54,7 +54,7 @@ end ---@param opts table: options to pass to the picker ---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer) ---@field grep_open_files boolean: if true, restrict search to open files only, mutually exclusive with `search_dirs` ----@field search_dirs table: directory/directories to search in, mutually exclusive with `grep_open_files` +---@field search_dirs table: directory/directories/files to search, mutually exclusive with `grep_open_files` ---@field glob_pattern string: argument to be used with `--glob`, e.g. "*.toml", can use the opposite "!*.toml" ---@field type_filter string: argument to be used with `--type`, e.g. "rust", see `rg --type-list` ---@field additional_args function: function(opts) which returns a table of additional arguments to be passed on @@ -66,7 +66,7 @@ builtin.live_grep = require_on_exported_call("telescope.builtin.files").live_gre ---@param opts table: options to pass to the picker ---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer) ---@field search string: the query to search ----@field search_dirs table: directory/directories to search in +---@field search_dirs table: directory/directories/files to search ---@field use_regex boolean: if true, special characters won't be escaped, allows for using regex (default: false) ---@field word_match string: can be set to `-w` to enable exact word matches ---@field additional_args function: function(opts) which returns a table of additional arguments to be passed on @@ -82,7 +82,7 @@ builtin.grep_string = require_on_exported_call("telescope.builtin.files").grep_s ---@field hidden boolean: determines whether to show hidden files or not (default: false) ---@field no_ignore boolean: show files ignored by .gitignore, .ignore, etc. (default: false) ---@field no_ignore_parent boolean: show files ignored by .gitignore, .ignore, etc. in parent dirs. (default: false) ----@field search_dirs table: directory/directories to search in +---@field search_dirs table: directory/directories/files to search builtin.find_files = require_on_exported_call("telescope.builtin.files").find_files --- This is an alias for the `find_files` picker