diff options
| author | Gutyina Gergő <gutyina.gergo.2@gmail.com> | 2022-10-24 08:44:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-24 08:44:13 +0200 |
| commit | 5c7db4055d89f9057d562f4f8b9d03189c9f9786 (patch) | |
| tree | 0a630d5d92f150c36779fec230f6037d8734f574 /doc | |
| parent | 286628d9f2056cc71d3f3871b5ca4f3209de0dbf (diff) | |
feat: allow table as additional args in live grep and grep string (#2139)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/telescope.txt | 90 |
1 files changed, 46 insertions, 44 deletions
diff --git a/doc/telescope.txt b/doc/telescope.txt index ba1fbc6..b573d65 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -772,28 +772,28 @@ builtin.live_grep({opts}) *telescope.builtin.live_grep()* {opts} (table) options to pass to the picker Options: ~ - {cwd} (string) root dir to search from - (default: cwd, use - utils.buffer_dir() to search - relative to open buffer) - {grep_open_files} (boolean) if true, restrict search to open - files only, mutually exclusive - with `search_dirs` - {search_dirs} (table) directory/directories/files to - search, mutually exclusive with - `grep_open_files` - {glob_pattern} (string|table) argument to be used with - `--glob`, e.g. "*.toml", can use - the opposite "!*.toml" - {type_filter} (string) argument to be used with - `--type`, e.g. "rust", see `rg - --type-list` - {additional_args} (function) function(opts) which returns a - table of additional arguments to - be passed on - {max_results} (number) define a upper result value - {disable_coordinates} (boolean) don't show the line & row - numbers (default: false) + {cwd} (string) root dir to search from + (default: cwd, use + utils.buffer_dir() to search + relative to open buffer) + {grep_open_files} (boolean) if true, restrict search to + open files only, mutually + exclusive with `search_dirs` + {search_dirs} (table) directory/directories/files to + search, mutually exclusive + with `grep_open_files` + {glob_pattern} (string|table) argument to be used with + `--glob`, e.g. "*.toml", can + use the opposite "!*.toml" + {type_filter} (string) argument to be used with + `--type`, e.g. "rust", see `rg + --type-list` + {additional_args} (function|table) additional arguments to be + passed on. Can be fn(opts) -> + tbl + {max_results} (number) define a upper result value + {disable_coordinates} (boolean) don't show the line & row + numbers (default: false) builtin.grep_string({opts}) *telescope.builtin.grep_string()* @@ -804,28 +804,30 @@ builtin.grep_string({opts}) *telescope.builtin.grep_string()* {opts} (table) options to pass to the picker Options: ~ - {cwd} (string) root dir to search from (default: - cwd, use utils.buffer_dir() to - search relative to open buffer) - {search} (string) the query to search - {grep_open_files} (boolean) if true, restrict search to open - files only, mutually exclusive with - `search_dirs` - {search_dirs} (table) directory/directories/files to - search, mutually exclusive with - `grep_open_files` - {use_regex} (boolean) if true, special characters won't be - escaped, allows for using regex - (default: false) - {word_match} (string) can be set to `-w` to enable exact - word matches - {additional_args} (function) function(opts) which returns a table - of additional arguments to be passed - on - {disable_coordinates} (boolean) don't show the line and row numbers - (default: false) - {only_sort_text} (boolean) only sort the text, not the file, - line or row (default: false) + {cwd} (string) root dir to search from + (default: cwd, use + utils.buffer_dir() to search + relative to open buffer) + {search} (string) the query to search + {grep_open_files} (boolean) if true, restrict search to + open files only, mutually + exclusive with `search_dirs` + {search_dirs} (table) directory/directories/files to + search, mutually exclusive + with `grep_open_files` + {use_regex} (boolean) if true, special characters + won't be escaped, allows for + using regex (default: false) + {word_match} (string) can be set to `-w` to enable + exact word matches + {additional_args} (function|table) additional arguments to be + passed on. Can be fn(opts) -> + tbl + {disable_coordinates} (boolean) don't show the line and row + numbers (default: false) + {only_sort_text} (boolean) only sort the text, not the + file, line or row (default: + false) builtin.find_files({opts}) *telescope.builtin.find_files()* |