Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Conni2461 committed Oct 24, 2022
1 parent 6812d15 commit 68d63d5
Showing 1 changed file with 46 additions and 44 deletions.
90 changes: 46 additions & 44 deletions doc/telescope.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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()*
Expand All @@ -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()*
Expand Down

0 comments on commit 68d63d5

Please sign in to comment.