leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: generate docgen

Browse Source 
i forgot it. My bad
This commit is contained in:
Simon Hauser
2021-09-01 16:53:56 +02:00
parent b0c04c62b5
commit baf39e5339
2 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/telescope.txt
View File

@@ -359,14 +359,17 @@ This will use the default configuration options. Other configuration options
are still in flux at the moment are still in flux at the moment
builtin.live_grep({opts}) *builtin.live_grep()* builtin.live_grep({opts}) *builtin.live_grep()*
Search for a string in your current working directory and get results live Search for a string and get results live as you type (respecting
as you type (respecting .gitignore) .gitignore)
Parameters: ~ Parameters: ~
{opts} (table) options to pass to the picker {opts} (table) options to pass to the picker
Fields: ~ Fields: ~
{cwd} (string) directory path to search from (default
is cwd, use utils.buffer_dir() to search
relative to open buffer)
{grep_open_files} (boolean) if true, restrict search to open files {grep_open_files} (boolean) if true, restrict search to open files
only, mutually exclusive with only, mutually exclusive with
`search_dirs` `search_dirs`
@@ -385,6 +388,9 @@ builtin.grep_string({opts}) *builtin.grep_string()*
{opts} (table) options to pass to the picker {opts} (table) options to pass to the picker
Fields: ~ Fields: ~
{cwd} (string) directory path to search from (default
is cwd, use utils.buffer_dir() to search
relative to open buffer)
{search} (string) the query to search {search} (string) the query to search
{search_dirs} (table) directory/directories to search in {search_dirs} (table) directory/directories to search in
{use_regex} (boolean) if true, special characters won't be {use_regex} (boolean) if true, special characters won't be
@@ -395,13 +401,16 @@ builtin.grep_string({opts}) *builtin.grep_string()*
builtin.find_files({opts}) *builtin.find_files()* builtin.find_files({opts}) *builtin.find_files()*
Lists files in your current working directory, respects .gitignore Search for files (respecting .gitignore)
Parameters: ~ Parameters: ~
{opts} (table) options to pass to the picker {opts} (table) options to pass to the picker
Fields: ~ Fields: ~
{cwd} (string) directory path to search from (default is
cwd, use utils.buffer_dir() to search
relative to open buffer)
{find_command} (table) command line arguments for `find_files` to {find_command} (table) command line arguments for `find_files` to
use for the search, overrides default config use for the search, overrides default config
{follow} (boolean) if true, follows symlinks (i.e. uses `-L` {follow} (boolean) if true, follows symlinks (i.e. uses `-L`
@@ -437,7 +446,9 @@ builtin.file_browser({opts}) *builtin.file_browser()*
{opts} (table) options to pass to the picker {opts} (table) options to pass to the picker
Fields: ~ Fields: ~
{cwd} (string) directory path to browse (default is cwd) {cwd} (string) directory path to browse (default is cwd, use
utils.buffer_dir() to browse relative to open
buffer)
{depth} (number) file tree depth to display (default is 1) {depth} (number) file tree depth to display (default is 1)
{dir_icon} (string) change the icon for a directory. default:  {dir_icon} (string) change the icon for a directory. default: 
{hidden} (boolean) determines whether to show hidden files or not {hidden} (boolean) determines whether to show hidden files or not

2
lua/telescope/utils.lua
View File

@@ -415,7 +415,7 @@ function utils.data_directory()
end end
function utils.buffer_dir() function utils.buffer_dir()
return vim.fn.expand('%:p:h') return vim.fn.expand "%:p:h"
end end
function utils.display_termcodes(str) function utils.display_termcodes(str)